Class Polygon

Geometry for GeoJSON independent Objects including Point, LineString, Polygon

no GeometryCollection
no MultiPoint, MultiLineString, MultiPolygon

Hierarchy

Geometry
- Polygon

Index

Constructors

Properties

bbox coordinates projection properties

Accessors

Methods

clone equals toGeoJSON toMultiPoint toXY updateBBox fromFeature fromGeoJSON fromGeometry isPolygon

Constructors

constructor

new Polygon(coordinates, properties?): Polygon
Parameters
- coordinates: [number, number][][]
- Optional properties: any
Returns Polygon
Overrides Geometry.constructor
- Defined in src/geometry/Polygon.ts:7

Properties

bbox

bbox: MBR = ...

`Readonly` coordinates

coordinates: any

`Readonly` projection

projection: Projection = SphericalMercator

properties

properties: any

Accessors

Properties

set Properties(properties): void
Parameters
- properties: any
Returns void
Inherited from Geometry.Properties
- Defined in src/geometry/Geometry.ts:49

Methods

clone

clone(): Geometry
Returns Geometry
Inherited from Geometry.clone
- Defined in src/geometry/Geometry.ts:51

equals

equals(geometry): boolean
Parameters
- geometry: Geometry
Returns boolean
Inherited from Geometry.equals
- Defined in src/geometry/Geometry.ts:58

toGeoJSON

toGeoJSON(): GeoJSONFeature
Returns GeoJSONFeature
Inherited from Geometry.toGeoJSON
- Defined in src/geometry/Geometry.ts:64

toMultiPoint

toMultiPoint(): MultiPoint
Returns MultiPoint
- Defined in src/geometry/Polygon.ts:16

toXY

toXY(): [number, number][][]
Returns [number, number][][]
Overrides Geometry.toXY
- Defined in src/geometry/Polygon.ts:11

updateBBox

updateBBox(): void
Returns void
Overrides Geometry.updateBBox
- Defined in src/geometry/Polygon.ts:20

`Static` fromFeature

fromFeature(feature): Polygon
Parameters
- feature: GeoJSONFeature
Returns Polygon
Overrides Geometry.fromFeature
- Defined in src/geometry/Polygon.ts:41

`Static` fromGeoJSON

fromGeoJSON(feature): Geometry | GeometryCollection
Parameters
- feature: GeoJSONGeometry | GeoJSONFeature
Returns Geometry | GeometryCollection
Inherited from Geometry.fromGeoJSON
- Defined in src/geometry/Geometry.ts:82

`Static` fromGeometry

fromGeometry(geometry): Polygon
Parameters
- geometry: GeoJSONPolygon
Returns Polygon
Overrides Geometry.fromGeometry
- Defined in src/geometry/Polygon.ts:37

`Static` isPolygon

isPolygon(geometry): geometry is Polygon
Parameters
- geometry: any
Returns geometry is Polygon
- Defined in src/geometry/Polygon.ts:33

Generated using TypeDoc