require(["esri/geometry/Polyline"], function(Polyline) { /* code goes here */ });
Class: esri/geometry/Polyline
Inheritance: Polyline Geometry Accessor
Since: ArcGIS API 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

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.
NameTypeSummaryClass
Object

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

more details
more detailsGeometry
String

The name of the class.

more details
more detailsAccessor
Extent

The extent of the geometry.

more details
more detailsGeometry
Boolean

Indicates if the geometry has M values.

more details
more detailsGeometry
Boolean

Indicates if the geometry has Z (elevation) values.

more details
more detailsGeometry
Number[][][]

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

more details
more detailsPolyline
SpatialReference

The spatial reference of the geometry.

more details
more detailsGeometry
String

For Polyline, the type is always polyline.

more details
more detailsPolyline

Property Details

cacheObjectreadonly inherited

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

declaredClassStringreadonly inherited

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

extentExtentreadonly inherited

The extent of the geometry. For points, the extent is null.

Indicates if the geometry has M values.

Indicates if the geometry has Z (elevation) values.

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.

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.

CaseVertex 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)
var 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]
 ]
];

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

The spatial reference of the geometry.

Default Value: WGS84 (wkid: 4326)

typeStringreadonly

For Polyline, the type is always polyline.

Method Overview

NameReturn TypeSummaryClass
Polyline

Adds a path, or line segment, to the polyline.

more details
more detailsPolyline
Polyline

Creates a deep clone of Polyline object.

more details
more detailsPolyline
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsGeometry
Point

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

more details
more detailsPolyline
Polyline

Inserts a new point into a polyline.

more details
more detailsPolyline
Point[]

Removes a path from the Polyline.

more details
more detailsPolyline
Point

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

more details
more detailsPolyline
Polyline

Updates a point in a polyline.

more details
more detailsPolyline
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsGeometry

Method Details

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 Number[][]

An array of lon/lat coordinate pairs from which to construct the path.

Returns:
TypeDescription
PolylineReturns the polyline with the newly added path added to the geometry.

clone(){Polyline}

Creates a deep clone of Polyline object.

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

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*Returns a new instance of this class.

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:
TypeDescription
PointReturns the point along the Polyline located in the given path and point indices.

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

Point geometry to insert into the path.

Returns:
TypeDescription
PolylineReturns the updated polyline.

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:
TypeDescription
Point[]Returns an array of points representing the removed path.

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:
TypeDescription
PointReturns the removed point.

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

Point geometry to update in the path.

Returns:
TypeDescription
PolylineReturns the updated polyline.

toJSON(){Object}inherited

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.