Class EsriPolyline

Hierarchy

EsriGeometry
- EsriPolyline

Index

Constructors

Properties

cache declaredClass destroyed extent hasM hasZ initialized paths spatialReference type

Methods

_get _set addHandles addPath clone destroy get getPoint hasHandles insertPoint notifyChange own removeHandles removePath removePoint set setPoint toJSON watch fromJSON

Constructors

constructor

new EsriPolyline(properties?): EsriPolyline
A polyline contains an array of paths and spatialReference.

Read more...
Parameters
- Optional properties: PolylineProperties
Returns EsriPolyline
Overrides EsriGeometry.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6412

Properties

`Readonly` cache

cache: any

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.

declaredClass

declaredClass: string

destroyed

destroyed: boolean

`Readonly` extent

extent: EsriExtent

The extent of the geometry.

hasM

hasM: boolean

Indicates if the geometry has M values.

hasZ

hasZ: boolean

Indicates if the geometry has z-values (elevation).

initialized

initialized: boolean

paths

paths: number[][][]

An array of paths, or line segments, that make up the polyline.

spatialReference

spatialReference: EsriSpatialReference

The spatial reference of the geometry.

Default

WGS84 (wkid: 4326)

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Geometry.html#spatialReference)

`Readonly` type

type: "polyline"

The geometry type.

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from EsriGeometry._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from EsriGeometry._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriPolyline
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriPolyline
Inherited from EsriGeometry._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from EsriGeometry.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

addPath

addPath(points): EsriPolyline
Adds a path, or line segment, to the polyline.

Read more...
Parameters
- points: number[][] | EsriPoint[]
Returns EsriPolyline
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6418

clone

clone(): EsriPolyline
Creates a deep clone of Polyline object.

Read more...

Returns EsriPolyline
Overrides EsriGeometry.clone
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6424

destroy

destroy(): void
Returns void
Inherited from EsriGeometry.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:20

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from EsriGeometry.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from EsriGeometry.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

getPoint

getPoint(pathIndex, pointIndex): EsriPoint
Returns a point specified by a path and point in the path.

Read more...
Parameters
- pathIndex: number
- pointIndex: number
Returns EsriPoint
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6430

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from EsriGeometry.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

insertPoint

insertPoint(pathIndex, pointIndex, point): EsriPolyline
Inserts a new point into a polyline.

Read more...
Parameters
- pathIndex: number
- pointIndex: number
- point: number[] | EsriPoint
Returns EsriPolyline
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6436

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from EsriGeometry.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from EsriGeometry.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from EsriGeometry.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

removePath

removePath(index): EsriPoint[]
Removes a path from the Polyline.

Read more...
Parameters
- index: number
Returns EsriPoint[]
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6442

removePoint

removePoint(pathIndex, pointIndex): EsriPoint
Removes a point from the polyline at the given pointIndex within the path identified by the given pathIndex.

Read more...
Parameters
- pathIndex: number
- pointIndex: number
Returns EsriPoint
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6448

set

set<T>(propertyName, value): EsriPolyline
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriPolyline
Inherited from EsriGeometry.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriPolyline
Parameters
- props: HashMap<any>
Returns EsriPolyline
Inherited from EsriGeometry.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

setPoint

setPoint(pathIndex, pointIndex, point): EsriPolyline
Updates a point in a polyline.

Read more...
Parameters
- pathIndex: number
- pointIndex: number
- point: number[] | EsriPoint
Returns EsriPolyline
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6454

toJSON

toJSON(): any
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any
Inherited from EsriGeometry.toJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2167

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from EsriGeometry.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

`Static` fromJSON

fromJSON(json): EsriPolyline
Parameters
- json: any
Returns EsriPolyline
Overrides EsriGeometry.fromJSON
- Defined in node_modules/@arcgis/core/interfaces.d.ts:6455

Class EsriPolyline

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: PolylineProperties

Returns EsriPolyline

Properties

Readonly cache

declaredClass

destroyed

Readonly extent

hasM

hasZ

initialized

paths

spatialReference

Default

Readonly type

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriPolyline

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

addPath

Parameters

points: number[][] | EsriPoint[]

Returns EsriPolyline

clone

Returns EsriPolyline

destroy

Returns void

get

Type Parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

getPoint

Parameters

pathIndex: number

pointIndex: number

Returns EsriPoint

hasHandles

Type Parameters

T

Parameters

Optional groupKey: Exclude<T, IHandle>

Returns boolean

insertPoint

Parameters

pathIndex: number

pointIndex: number

point: number[] | EsriPoint

`Optional` properties: PolylineProperties

`Readonly` cache

`Readonly` extent

`Readonly` type

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` groupKey: Exclude<T, IHandle>

`Protected` notifyChange

`Optional` groupKey: Exclude<T, IHandle>

`Optional` sync: boolean

`Static` fromJSON