Polyline | @types/arcgis-js-api

Hierarchy

Geometry
- Polyline

Index

Properties

Methods

Properties

Readonly cache

cache: any

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

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly extent

extent: Extent

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: SpatialReference

The spatial reference of the geometry.

Readonly type

type: "polyline"

Methods

Protected _get

_get(propertyName: string): any
_get<T>(propertyName: string): T

Inherited from Geometry._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:35
Parameters
- propertyName: string
Returns any
Inherited from Geometry._get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:36
Type parameters
- T
Parameters
- propertyName: string
Returns T

Protected _set

_set<T>(propertyName: string, value: T): Polyline

Inherited from Geometry._set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:37
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Polyline

addPath

addPath(points: number[][] | Point[]): Polyline

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5030
Adds a path, or line segment, to the polyline.

Read more...

Parameters
- points: number[][] | Point[]
Returns Polyline

clone

clone(): Polyline

Overrides Geometry.clone
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5036
Creates a deep clone of Polyline object.

Read more...

Returns Polyline

destroy

destroy(): void

Inherited from Geometry.destroy
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:26
Returns void

get

get<T>(propertyName: string): T
get(propertyName: string): any

Inherited from Geometry.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:28
Type parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Geometry.get
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:29
Parameters
- propertyName: string
Returns any

getPoint

getPoint(pathIndex: number, pointIndex: number): Point

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5042
Returns a point specified by a path and point in the path.

Read more...

Parameters
- pathIndex: number
- pointIndex: number
Returns Point

insertPoint

insertPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5048
Inserts a new point into a polyline.

Read more...

Parameters
- pathIndex: number
- pointIndex: number
- point: Point | number[]
Returns Polyline

Protected notifyChange

notifyChange(propertyName: string): void

Inherited from Geometry.notifyChange
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:34
Parameters
- propertyName: string
Returns void

removePath

removePath(index: number): Point[]

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5054
Removes a path from the Polyline.

Read more...

Parameters
- index: number
Returns Point[]

removePoint

removePoint(pathIndex: number, pointIndex: number): Point

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5060
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 Point

set

set<T>(propertyName: string, value: T): Polyline
set(props: HashMap<any>): Polyline

Inherited from Geometry.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:30
Type parameters
- T
Parameters
- propertyName: string
- value: T
Returns Polyline
Inherited from Geometry.set
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:31
Parameters
- props: HashMap<any>
Returns Polyline

setPoint

setPoint(pathIndex: number, pointIndex: number, point: Point | number[]): Polyline

- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:5066
Updates a point in a polyline.

Read more...

Parameters
- pathIndex: number
- pointIndex: number
- point: Point | number[]
Returns Polyline

toJSON

toJSON(): any

Inherited from Geometry.toJSON
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:1214
Converts an instance of this class to its ArcGIS portal JSON representation.

Read more...

Returns any

watch

watch(path: string | string[], callback: WatchCallback, sync?: boolean): WatchHandle

Inherited from Geometry.watch
- Defined in tmpUZesca/_types_arcgis-js-api/node_modules/@types/arcgis-js-api/index.d.ts:32
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle

Hierarchy

Index

Properties

Methods

Properties

Readonly cache

declaredClass

destroyed

Readonly extent

hasM

hasZ

initialized

paths

spatialReference

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 Polyline

addPath

Parameters

points: number[][] | Point[]

Returns Polyline

clone

Returns Polyline

destroy

Returns void

get

Type parameters

T

Parameters

propertyName: string

Returns T

Parameters

propertyName: string

Returns any

getPoint

Parameters

pathIndex: number

pointIndex: number

Returns Point

insertPoint

Parameters

pathIndex: number

pointIndex: number

point: Point | number[]

Returns Polyline

Protected notifyChange

Parameters

propertyName: string

Returns void

removePath

Parameters

index: number

Returns Point[]

removePoint

Parameters

pathIndex: number

pointIndex: number

Returns Point

set

Type parameters

T

Parameters

propertyName: string

value: T

Returns Polyline