Class LineString

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

Hierarchy (view full)

PointSet
- LineString

Index

Constructors

constructor

new LineString(id, line): LineString
Constructs a LineString from the given source of a line
Parameters
- id: IdDef
  An identifier for the LineString
- line: LineString
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:17
new LineString(id, multiPoint): LineString
Parameters
- id: IdDef
  Id of the geometry
- multiPoint: MultiPoint
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:18
new LineString(id, listOfCoords, sr?, raw?): LineString
Parameters
- id: IdDef
  Id of the geometry
- listOfCoords: number[][]
- Optionalsr: SrDef
  Spatial Reference of the geometry
- Optionalraw: boolean
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:20
new LineString(id, listOfPoints, sr?): LineString
Parameters
- id: IdDef
  Id of the geometry
- listOfPoints: Point[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:21
new LineString(id, listOfXY, sr?): LineString
Parameters
- id: IdDef
  Id of the geometry
- listOfXY: object[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:22
new LineString(id, listOfMixedFormats, sr?): LineString
Parameters
- id: IdDef
  Id of the geometry
- listOfMixedFormats: any[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns LineString
Overrides PointSet.constructor
- Defined in src/geo/api/graphic/geometry/line-string.ts:23

Properties

`Readonly`id

id: string

Id of the geometry

`Protected`rawArray

rawArray: number[][]

sr

sr: SpatialReference

Spatial Reference of the geometry

Accessors

length

get length(): number
Returns the number of contained points.

Returns number
Inherited from PointSet.length
- Defined in src/geo/api/graphic/geometry/point-set.ts:55

pointArray

get pointArray(): Point[]
Returns an array of the contained lines formatted as API Point objects. A new array is returned each time this is called.

Returns Point[]
Inherited from PointSet.pointArray
- Defined in src/geo/api/graphic/geometry/point-set.ts:39

type

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

Returns GeometryType
Overrides PointSet.type
- Defined in src/geo/api/graphic/geometry/line-string.ts:32

Methods

`Protected`childIdGenerator

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

`Protected`geoJsonFactory

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

getAt

getAt(n): Point
Returns a copy of the n-th contained point.
Parameters
- n: number
Returns Point
Inherited from PointSet.getAt
- Defined in src/geo/api/graphic/geometry/point-set.ts:44

invalid

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

toArray

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

Returns number[][]
Inherited from PointSet.toArray
- Defined in src/geo/api/graphic/geometry/point-set.ts:64

toESRI

toESRI(): Polyline
Returns Polyline
Overrides PointSet.toESRI
- Defined in src/geo/api/graphic/geometry/line-string.ts:41

toGeoJSON

toGeoJSON(): LineString
Returns LineString
Overrides PointSet.toGeoJSON
- Defined in src/geo/api/graphic/geometry/line-string.ts:52

updateAt

updateAt(point, n): void
Will update the n-th contained point with the values of the point parameter. It is assumed the point is in the same spatial reference as the Multipoint
Parameters
- point: object | number[] | Point
- n: number
Returns void
Inherited from PointSet.updateAt
- Defined in src/geo/api/graphic/geometry/point-set.ts:49

`Static`fromESRI

fromESRI(esriLine, id?): LineString
Parameters
- esriLine: Polyline
- Optionalid: string | number
Returns LineString
- Defined in src/geo/api/graphic/geometry/line-string.ts:36

`Static`fromGeoJSON

fromGeoJSON(geoJsonLine, id?): LineString
Parameters
- geoJsonLine: LineString
- Optionalid: string | number
Returns LineString
- Defined in src/geo/api/graphic/geometry/line-string.ts:48

`Static`parsePointSet

parsePointSet(input): number[][]
Parameters
- input: any
Returns number[][]
Inherited from PointSet.parsePointSet
- Defined in src/geo/api/graphic/geometry/point-set.ts:71

Class LineString

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LineString

Parameters

Returns LineString

Parameters

Returns LineString

Parameters

Returns LineString

Parameters

Returns LineString

Parameters

Returns LineString

Properties

Readonlyid

ProtectedrawArray

sr

Accessors

length

Returns number

pointArray

Returns Point[]

type

Returns GeometryType

Methods

ProtectedchildIdGenerator

Parameters

Returns string

ProtectedgeoJsonFactory

Parameters

Returns DirectGeometryObject

getAt

Parameters

Returns Point

invalid

Returns boolean

toArray

Returns number[][]

toESRI

Returns Polyline

toGeoJSON

Returns LineString

updateAt

Parameters

Returns void

StaticfromESRI

Parameters

Returns LineString

StaticfromGeoJSON

Parameters

Returns LineString

StaticparsePointSet

Parameters

Returns number[][]

Settings

On This Page

`Readonly`id

`Protected`rawArray

`Protected`childIdGenerator

`Protected`geoJsonFactory

`Static`fromESRI

`Static`fromGeoJSON

`Static`parsePointSet