Polyline | API Reference | ArcGIS Maps SDK for JavaScript 4.30

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

Polyline Constructor new Polyline(properties)

Parameter

properties Object

optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Object	The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation.	Geometry
String	The name of the class.	Accessor
Extent	The extent of the geometry.	Geometry
Boolean	Indicates if the geometry has M values.	Geometry
Boolean	Indicates if the geometry has z-values (elevation).	Geometry
Number [][][]	An array of paths, or line segments, that make up the polyline.	Polyline
SpatialReference	The spatial reference of the geometry.	Geometry
String	For Polyline the type is always "polyline".	Polyline

Property Details

cache Inherited Property cache Objectreadonly 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.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

extent Inherited Property extent Extentreadonly Inherited from Geometry

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

hasM Inherited Property hasM Boolean Inherited from Geometry

Indicates if the geometry has M values.

hasZ Inherited Property hasZ 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.

paths Property paths 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 Inherited Property spatialReference SpatialReferenceautocast Inherited from Geometry

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)

type Property type Stringreadonly

For Polyline the type is always "polyline".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Polyline	Adds a path, or line segment, to the polyline.	Polyline
Polyline	Creates a deep clone of Polyline object.	Polyline
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Geometry
Point	Returns a point specified by a path and point in the path.	Polyline
Boolean	Returns true if a named group of handles exist.	Accessor
Polyline	Inserts a new point into a polyline.	Polyline
	Removes a group of handles owned by the object.	Accessor
Point []	Removes a path from the Polyline.	Polyline
Point	Removes a point from the polyline at the given `pointIndex` within the path identified by the given `pathIndex`.	Polyline
Polyline	Updates a point in a polyline.	Polyline
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Geometry

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

addPath Method addPath(points){Polyline}

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

Parameter

points Point []|Number [][]

A polyline path. This can either be defined as an array of Point geometries or an array of XY coordinates.

Returns

Type	Description
Polyline	Returns the polyline with the new path included.

clone Method clone(){Polyline}

Creates a deep clone of Polyline object.

Returns

Type	Description
Polyline	A new instance of a Polyline object equal to the object used to call `.clone()`.

fromJSON Inherited Method fromJSON(json){*}static

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.

Parameter

json Object

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

Type	Description
*	Returns a new instance of this class.

getPoint Method getPoint(pathIndex, pointIndex){Point}

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

Parameters

pathIndex Number

The index of a path in the polyline.

pointIndex Number

The index of a point in a path.

Returns

Type	Description
Point	Returns the point along the Polyline located in the given path and point indices.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

insertPoint Method insertPoint(pathIndex, pointIndex, point){Polyline}

Inserts a new point into a polyline.

Parameters

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

Type	Description
Polyline	Returns the updated polyline.

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

removePath Method removePath(index){Point[]}

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

Parameter

index Number

The index of the path to remove from the polyline.

Returns

Type	Description
Point []	Returns an array of points representing the removed path.

removePoint Method removePoint(pathIndex, pointIndex){Point}

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

Parameters

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

Type	Description
Point	Returns the removed point.

setPoint Method setPoint(pathIndex, pointIndex, point){Polyline}

Updates a point in a polyline.

Parameters

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

Type	Description
Polyline	Returns the updated polyline.

toJSON Inherited Method toJSON(){Object} Inherited from Geometry

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

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.