Polyline | References | ArcGIS Maps SDK for JavaScript

import Polyline from "@arcgis/core/geometry/Polyline.js";

Inheritance:: Polyline→Geometry→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

A polyline contains an array of paths and spatialReference. Each path is represented as an array of points. A polyline also has boolean-valued hasM and hasZ properties.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`PolylineProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`cache` readonly inherited	`Record<string, any>`	Geometry
`curvePaths`	`CurveJSON[][] \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`extent` readonly inherited	`Extent \| null \| undefined`	Geometry
`hasM` inherited	`boolean`	Geometry
`hasZ` inherited	`boolean`	Geometry
`paths`	`number[][][]`
`spatialReference` inherited	`SpatialReference`	Geometry
`type` readonly	`"polyline"`

cache

readonlyinherited Property

Type: Record<string, any>

Inherited from: Geometry

The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.

curvePaths

Property

Type: CurveJSON[][] | undefined

An array consisting of points and curve objects that define the polyline geometry.

Example

// Polyline with two circular arc segments represented with curve objects.
const curvedLine = new Polyline({
  curvePaths: [
    [
      [-13950813.6947, 4028697.5532],
      [-13878602.7757, 4026346.5],
      {
        c: [
          [-13854084.6497, 4009553.2631],
          [-13841976.9737328, 4053525.320625]
        ]
      },
      {
        c: [
          [-13851733.5965, 4069673.0515],
          [-13791446.6027123, 4037209.59502735]
        ]
      }
    ]
  ],
  spatialReference: { wkid: 102100 }
});

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extent

readonlyinherited Property

Type: Extent | null | undefined

Inherited from: Geometry

The extent of the geometry. For a point, the extent is null.

hasM

inherited Property

Type: boolean

Inherited from: Geometry

Indicates if the geometry has M values.

Default value: false

hasZ

inherited Property

Type: boolean

Inherited from: Geometry

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

Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.

Default value: false

paths

Property

Type: number[][][]

An array of paths, or line segments, that make up the polyline. Each path is a two-dimensional array of numbers representing the coordinates of each vertex in the path in the spatial reference of the view. Each vertex is represented as an array of two, three, or four numbers. The table below shows the various structures of a vertex array.

Case	Vertex array
without z and without m	[x, y]
without z and with m	[x, y, m]
with z and without m	[x, y, z]
with z and with m	[x, y, z, m]

Example

// 2D polyline with to paths with m-values (note that the 2nd path does not have m-values defined)
let paths = [
 [  // first path
  [-97.06138,32.837,5],
  [-97.06133,32.836,6],
  [-97.06124,32.834,7]
 ], [  // second path
  [-97.06326,32.759],
  [-97.06298,32.755]
 ]
];

let line = new Polyline({
  hasZ: false,
  hasM: true,
  paths: paths,
  spatialReference: { wkid: 4326 }
});

spatialReference

autocast inherited Property

Type: SpatialReference

Inherited from: Geometry

The spatial reference of the geometry.

Default value: SpatialReference.WGS84 // wkid: 4326

type

readonly Property

Type: "polyline"

The geometry type.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`addPath`	`addPath(points: number[][] \| Point[]): this`
`clone`	`clone(): Polyline`
`getPoint`	`getPoint(pathIndex: number, pointIndex: number): Point \| null \| undefined`
`insertPoint`	`insertPoint(pathIndex: number, pointIndex: number, point: Point \| number[]): this`
`removePath`	`removePath(index: number): Point[] \| null \| undefined`
`removePoint`	`removePoint(pathIndex: number, pointIndex: number): Point \| null \| undefined`
`setPoint`	`setPoint(pathIndex: number, pointIndex: number, point: Point \| number[]): this`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

addPath

Method

Signature: addPath (points: number[][] | Point[]): this

Adds a path, or line segment, to the polyline. When added, the index of the path is incremented by one.

Parameters

Parameter	Type	Description	Required
points	`number[][] \| Point[]`	A polyline path. This can either be defined as an array of Point geometries or an array of XY coordinates.

Returns: this
Returns the polyline with the new path included.

clone

Method

Signature: clone (): Polyline

Creates a deep clone of Polyline object.

Returns: Polyline
A new instance of a Polyline object equal to the object used to call .clone().

getPoint

Method

Signature: getPoint (pathIndex: number, pointIndex: number): Point | null | undefined

Returns a point specified by a path and point in the path.

Parameters

Parameter	Type	Description	Required
pathIndex	`number`	The index of a path in the polyline.
pointIndex	`number`	The index of a point in a path.

Returns: Point | null | undefined
Returns the point along the Polyline located in the given path and point indices.

insertPoint

Method

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

Inserts a new point into a polyline.

Parameters

Parameter	Type	Description
pathIndex	`number`	The index of the path in which to insert a point.
pointIndex	`number`	The index of the inserted point in the path.
point	`Point \| number[]`	The point to insert.

Returns: this
Returns the updated polyline.

removePath

Method

Signature: removePath (index: number): Point[] | null | undefined

Removes a path from the Polyline. The index specifies which path to remove.

Parameters

Parameter	Type	Description	Required
index	`number`	The index of the path to remove from the polyline.

Returns: Point[] | null | undefined
Returns an array of points representing the removed path.

removePoint

Method

Signature: removePoint (pathIndex: number, pointIndex: number): Point | null | undefined

Removes a point from the polyline at the given pointIndex within the path identified by the given pathIndex.

Parameters

Parameter	Type	Description	Required
pathIndex	`number`	The index of the path containing the point to be removed.
pointIndex	`number`	The index of the point to be removed within the path.

Returns: Point | null | undefined
Returns the removed point.

setPoint

Method

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

Updates a point in a polyline.

Parameters

Parameter	Type	Description
pathIndex	`number`	The index of the path that contains the point to be updated.
pointIndex	`number`	The index of the point to be updated in the path.
point	`Point \| number[]`	Point geometry to update in the path.

Returns: this
Returns the updated polyline.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.