Class CurvePolygon<T>

A planar surface defined by an exterior ring and zero or more interior ring. Each ring is defined by a Curve instance.

Type parameters

T: Curve

curve type

Hierarchy

Surface
- CurvePolygon
  - Polygon

Index

Constructors

constructor

Accessors

Constructors

constructor

new CurvePolygon(): CurvePolygon
new CurvePolygon(hasZ: boolean, hasM: boolean): CurvePolygon
new CurvePolygon(rings: Array<T>): CurvePolygon
new CurvePolygon(ring: T): CurvePolygon
new CurvePolygon(curvePolygon: CurvePolygon<T>): CurvePolygon
new CurvePolygon(type: GeometryType, hasZ: boolean, hasM: boolean): CurvePolygon

Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:12
Constructor Constructor

Returns CurvePolygon
Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:14
Constructor Constructor

Parameters
- hasZ: boolean
- hasM: boolean
Returns CurvePolygon
Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:15
Constructor Constructor

Parameters
- rings: Array<T>
Returns CurvePolygon
Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:16
Constructor Constructor

Parameters
- ring: T
Returns CurvePolygon
Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:17
Constructor Constructor

Parameters
- curvePolygon: CurvePolygon<T>
Returns CurvePolygon
Overrides Surface.constructor
- Defined in lib/CurvePolygon.ts:18
Constructor Constructor

Parameters
- type: GeometryType
- hasZ: boolean
- hasM: boolean
Returns CurvePolygon

Accessors

geometryType

get geometryType(): GeometryType

Inherited from Geometry.geometryType
- Defined in lib/Geometry.ts:39
Get the geometry type

Returns GeometryType

geometry type

hasM

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

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:72
Does the geometry have m coordinates

Returns boolean

true if has m coordinates
Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:80
Set if the geometry has m coordinates

Parameters
- hasM: boolean
  
  true if has m coordinates
Returns void

true if has m coordinates

hasZ

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

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:47
Does the geometry have z coordinates

Returns boolean

true if has z coordinates
Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:55
Set if the geometry has z coordinates

Parameters
- hasZ: boolean
  
  true if has z coordinates
Returns void

true if has z coordinates

is3D

get is3D(): boolean

Inherited from Geometry.is3D
- Defined in lib/Geometry.ts:64
Does the geometry have z coordinates

see

#hasZ()

Returns boolean

true if has z coordinates

rings

get rings(): Array<T>
set rings(rings: Array<T>): void

- Defined in lib/CurvePolygon.ts:53
Get the rings

Returns Array<T>

rings
- Defined in lib/CurvePolygon.ts:61
Set the rings

Parameters
- rings: Array<T>
  
  rings
Returns void

rings

Methods

addRing

addRing(ring: T): void

- Defined in lib/CurvePolygon.ts:70
Add a ring

Parameters
- ring: T
  
  ring
Returns void

addRings

addRings(rings: Array<T>): void

- Defined in lib/CurvePolygon.ts:79
Add rings

Parameters
- rings: Array<T>
  
  rings
Returns void

copy

copy(): Geometry

Overrides Geometry.copy
- Defined in lib/CurvePolygon.ts:131
{@inheritDoc}

Returns Geometry

equals

equals(obj: Geometry): boolean

Overrides Geometry.equals
- Defined in lib/CurvePolygon.ts:152
{@inheritDoc}

Parameters
- obj: Geometry
Returns boolean

expandEnvelope

expandEnvelope(envelope: GeometryEnvelope): void

Inherited from Geometry.expandEnvelope
- Defined in lib/Geometry.ts:150
Expand the envelope with the minimum bounding box for this Geometry

Parameters
- envelope: GeometryEnvelope
  
  geometry envelope to expand
Returns void

getCentroid

getCentroid(): Point

Inherited from Geometry.getCentroid
- Defined in lib/Geometry.ts:170
Get the mathematical centroid point of a 2 dimensional representation of the Geometry (balancing point of a 2d cutout of the geometry). Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDegreesCentroid

getDegreesCentroid(): Point

Inherited from Geometry.getDegreesCentroid
- Defined in lib/Geometry.ts:181
Get the geographic centroid point of a 2 dimensional representation of the degree unit Geometry. Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

Returns Point

centroid point

getDimension

getDimension(): number

Inherited from Geometry.getDimension
- Defined in lib/Geometry.ts:158
Get the inherent dimension (0, 1, or 2) for this Geometry

Returns number

dimension

getEnvelope

getEnvelope(): GeometryEnvelope

Inherited from Geometry.getEnvelope
- Defined in lib/Geometry.ts:142
Get the minimum bounding box for this Geometry

Returns GeometryEnvelope

geometry envelope

getExteriorRing

getExteriorRing(): T

- Defined in lib/CurvePolygon.ts:106
Get the exterior ring

Returns T

exterior ring

getInteriorRing

getInteriorRing(n: number): T

- Defined in lib/CurvePolygon.ts:124
Returns the Nth interior ring for this Polygon

Parameters
- n: number
  
  interior ring number
Returns T

interior ring

getRing

getRing(n: number): Curve

- Defined in lib/CurvePolygon.ts:97
Returns the Nth ring where the exterior ring is at 0, interior rings begin at 1

Parameters
- n: number
  
  nth ring to return
Returns Curve

ring

isEmpty

isEmpty(): boolean

Overrides Geometry.isEmpty
- Defined in lib/CurvePolygon.ts:138
{@inheritDoc}

Returns boolean

isMeasured

isMeasured(): boolean

Inherited from Geometry.isMeasured
- Defined in lib/Geometry.ts:134
Does the geometry have m coordinates.

see

#hasM()

Returns boolean

true if has m coordinates

isSimple

isSimple(): boolean

Overrides Geometry.isSimple
- Defined in lib/CurvePolygon.ts:145
{@inheritDoc}

Returns boolean

numInteriorRings

numInteriorRings(): number

- Defined in lib/CurvePolygon.ts:115
Get the number of interior rings

Returns number

number of interior rings

numRings

numRings(): number

- Defined in lib/CurvePolygon.ts:87
Get the number of rings including exterior and interior

Returns number

number of rings

updateZM

updateZM(geometry: Geometry): void

Inherited from Geometry.updateZM
- Defined in lib/Geometry.ts:88
Update currently false hasZ and hasM values using the provided geometry

Parameters
- geometry: Geometry
  
  geometry
Returns void

Static hasM

hasM(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasM
- Defined in lib/Geometry.ts:118
Determine if the geometries contain a M value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has m

Static hasZ

hasZ(geometries: Array<Geometry>): boolean

Inherited from Geometry.hasZ
- Defined in lib/Geometry.ts:102
Determine if the geometries contain a Z value

Parameters
- geometries: Array<Geometry>
  
  list of geometries
Returns boolean

true if has z

Generated using TypeDoc