Class Polygon

Baseclass of all geometries. All geometry types must derive from this class. Not intented to be instantiated on its own.

Hierarchy (View Summary)

BaseGeometry
- Polygon

Index

Constructors

constructor

new Polygon(id: IdDef, polygon: Polygon): Polygon
Constructs a LinearRing from the given source of a line. Will close the line if it's not already closed
Parameters
- id: IdDef
  An identifier for the LineString
- polygon: Polygon
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:29
new Polygon(id: IdDef, multiLine: MultiLineString): Polygon
Parameters
- id: IdDef
- multiLine: MultiLineString
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:30
new Polygon(id: IdDef, linearRing: LinearRing): Polygon
Parameters
- id: IdDef
- linearRing: LinearRing
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:32
new Polygon(id: IdDef, line: LineString): Polygon
Parameters
- id: IdDef
- line: LineString
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:33
new Polygon(id: IdDef, multiPoint: MultiPoint): Polygon
Parameters
- id: IdDef
- multiPoint: MultiPoint
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:34
new Polygon(
    id: IdDef,
    listOfListOfCoords: number[][][],
    sr?: SrDef,
    raw?: boolean,
): Polygon
Parameters
- id: IdDef
- listOfListOfCoords: number[][][]
- Optionalsr: SrDef
- Optionalraw: boolean
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:36
new Polygon(id: IdDef, listOfListOfPoints: Point[][], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfListOfPoints: Point[][]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:37
new Polygon(id: IdDef, listOfListOfXY: object[][], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfListOfXY: object[][]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:38
new Polygon(id: IdDef, listOfLinearRings: LinearRing[], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfLinearRings: LinearRing[]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:39
new Polygon(id: IdDef, listOfLines: LineString[], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfLines: LineString[]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:40
new Polygon(id: IdDef, listOfMultiPoints: MultiPoint[], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfMultiPoints: MultiPoint[]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:41
new Polygon(id: IdDef, listOfMixedFormats: any[], sr?: SrDef): Polygon
Parameters
- id: IdDef
- listOfMixedFormats: any[]
- Optionalsr: SrDef
Returns Polygon
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/polygon.ts:42

Properties

`Readonly`id

id: string

Id of the geometry

`Protected`rawArray

rawArray: number[][][]

sr

sr: SpatialReference

Spatial Reference of the geometry

Accessors

ringArray

get ringArray(): LinearRing[]
Returns an array of the contained rings. A new array is returned each time this is called.

Returns LinearRing[]
- Defined in src/geo/api/graphic/geometry/polygon.ts:67

type

get type(): GeometryType
Returns the string 'Polygon'.

Returns GeometryType
Overrides BaseGeometry.type
- Defined in src/geo/api/graphic/geometry/polygon.ts:72

Methods

addLinearRings

addLinearRings(linearRings: LinearRing[]): void
Parameters
- linearRings: LinearRing[]
Returns void
- Defined in src/geo/api/graphic/geometry/polygon.ts:58

`Protected`childIdGenerator

childIdGenerator(idx: number): string
Parameters
- idx: number
Returns string
Inherited from BaseGeometry.childIdGenerator
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:29

`Protected`geoJsonFactory

geoJsonFactory(type: string, coords: any[]): DirectGeometryObject
Parameters
- type: string
- coords: any[]
Returns DirectGeometryObject
Inherited from BaseGeometry.geoJsonFactory
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:45

invalid

invalid(): boolean
Returns boolean
Inherited from BaseGeometry.invalid
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:41

toArray

toArray(): number[][][]
Returns an array of ring arrays (e.g. [[[x1, y1], [x2, y2], [x3, y3], [x1, y1]], []] )

Returns number[][][]
- Defined in src/geo/api/graphic/geometry/polygon.ts:79

toESRI

toESRI(): Polygon
Returns Polygon
Overrides BaseGeometry.toESRI
- Defined in src/geo/api/graphic/geometry/polygon.ts:117

toGeoJSON

toGeoJSON(): Polygon
Returns Polygon
Overrides BaseGeometry.toGeoJSON
- Defined in src/geo/api/graphic/geometry/polygon.ts:128

`Static`arrayDeepCopy

arrayDeepCopy(a: number[][][]): number[][][]
Parameters
- a: number[][][]
Returns number[][][]
- Defined in src/geo/api/graphic/geometry/polygon.ts:108

`Static`fromESRI

fromESRI(esriPoly: Polygon, id?: string | number): Polygon
Parameters
- esriPoly: Polygon
- Optionalid: string | number
Returns Polygon
- Defined in src/geo/api/graphic/geometry/polygon.ts:113

`Static`fromGeoJSON

fromGeoJSON(geoJsonPoly: Polygon, id?: string | number): Polygon
Parameters
- geoJsonPoly: Polygon
- Optionalid: string | number
Returns Polygon
- Defined in src/geo/api/graphic/geometry/polygon.ts:124

`Static`parsePolygon

parsePolygon(input: any): number[][][]
Parameters
- input: any
Returns number[][][]
- Defined in src/geo/api/graphic/geometry/polygon.ts:83

Class Polygon

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Parameters

Returns Polygon

Properties

Readonlyid

ProtectedrawArray

sr

Accessors

ringArray

Returns LinearRing[]

type

Returns GeometryType

Methods

addLinearRings

Parameters

Returns void

ProtectedchildIdGenerator

Parameters

Returns string

ProtectedgeoJsonFactory

Parameters

Returns DirectGeometryObject

invalid

Returns boolean

toArray

Returns number[][][]

toESRI

Returns Polygon

toGeoJSON

Returns Polygon

StaticarrayDeepCopy

Parameters

Returns number[][][]

StaticfromESRI

Parameters

Returns Polygon

StaticfromGeoJSON

Parameters

Returns Polygon

StaticparsePolygon

Parameters

Returns number[][][]

Settings

On This Page

`Readonly`id

`Protected`rawArray

`Protected`childIdGenerator

`Protected`geoJsonFactory

`Static`arrayDeepCopy

`Static`fromESRI

`Static`fromGeoJSON

`Static`parsePolygon