Class MultiLineString

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

Hierarchy (view full)

BaseGeometry
- MultiLineString

Index

Constructors

constructor

new MultiLineString(id, multiLine): MultiLineString
Constructs a MultiLineString from the given source of lines
Parameters
- id: IdDef
  An identifier for the MultiLineString
- multiLine: MultiLineString
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:27
new MultiLineString(id, line): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- line: LineString
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:29
new MultiLineString(id, multiPoint): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- multiPoint: MultiPoint
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:30
new MultiLineString(id, listOfListOfCoords, sr?, raw?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfListOfCoords: number[][][]
- Optionalsr: SrDef
  Spatial Reference of the geometry
- Optionalraw: boolean
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:32
new MultiLineString(id, listOfLines, sr?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfLines: LineString[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:33
new MultiLineString(id, listOfMultiPoints, sr?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfMultiPoints: MultiPoint[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:34
new MultiLineString(id, listOfListOfPoints, sr?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfListOfPoints: Point[][]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:35
new MultiLineString(id, listOfListOfXY, sr?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfListOfXY: object[][]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:36
new MultiLineString(id, listOfMixedFormats, sr?): MultiLineString
Parameters
- id: IdDef
  Id of the geometry
- listOfMixedFormats: any[]
- Optionalsr: SrDef
  Spatial Reference of the geometry
Returns MultiLineString
Overrides BaseGeometry.constructor
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:37

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 lines.

Returns number
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:85

lineArray

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

Returns LineString[]
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:69

type

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

Returns GeometryType
Overrides BaseGeometry.type
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:90

Methods

`Protected`childIdGenerator

childIdGenerator(idx): 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, coords): DirectGeometryObject
Parameters
- type: string
- coords: any[]
Returns DirectGeometryObject
Inherited from BaseGeometry.geoJsonFactory
- Defined in src/geo/api/graphic/geometry/base-geometry.ts:45

getAt

getAt(n): LineString
Returns a copy of the n-th contained line.
Parameters
- n: number
Returns LineString
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:74

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 line arrays (e.g. [[[x1, y1], [x2, y2]], [[x3, y3], [x4, y4]]] )

Returns number[][][]
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:97

toESRI

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

toGeoJSON

toGeoJSON(): MultiLineString
Returns MultiLineString
Overrides BaseGeometry.toGeoJSON
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:126

updateAt

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

`Static`fromESRI

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

`Static`fromGeoJSON

fromGeoJSON(geoJsonMultiLine, id?): MultiLineString
Parameters
- geoJsonMultiLine: MultiLineString
- Optionalid: string | number
Returns MultiLineString
- Defined in src/geo/api/graphic/geometry/multi-line-string.ts:117

Class MultiLineString

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Parameters

Returns MultiLineString

Properties

Readonlyid

ProtectedrawArray

sr

Accessors

length

Returns number

lineArray

Returns LineString[]

type

Returns GeometryType

Methods

ProtectedchildIdGenerator

Parameters

Returns string

ProtectedgeoJsonFactory

Parameters

Returns DirectGeometryObject

getAt

Parameters

Returns LineString

invalid

Returns boolean

toArray

Returns number[][][]

toESRI

Returns Polyline

toGeoJSON

Returns MultiLineString

updateAt

Parameters

Returns void

StaticfromESRI

Parameters

Returns MultiLineString

StaticfromGeoJSON

Parameters

Returns MultiLineString

Settings

On This Page

`Readonly`id

`Protected`rawArray

`Protected`childIdGenerator

`Protected`geoJsonFactory

`Static`fromESRI

`Static`fromGeoJSON