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.
Constructors
-
new Polyline(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Object | The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. more details | Geometry | |
String | The name of the class. more details | Accessor | |
Extent | The extent of the geometry. more details | Geometry | |
Boolean | Indicates if the geometry has M values. more details | Geometry | |
Boolean | Indicates if the geometry has z-values (elevation). more details | Geometry | |
Number[][][] | An array of paths, or line segments, that make up the polyline. more details | Polyline | |
SpatialReference | The spatial reference of the geometry. more details | Geometry | |
String | For Polyline the type is always "polyline". more details | Polyline |
Property Details
-
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.
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
The extent of the geometry. For a point, the extent is null.
-
Indicates if the geometry has M values.
-
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.
-
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 } });
-
-
The spatial reference of the geometry.
- Default Value:WGS84 (wkid: 4326)
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Polyline | Adds a path, or line segment, to the polyline. more details | Polyline | |
Polyline | Creates a deep clone of Polyline object. more details | Polyline | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | Geometry | |
Point | Returns a point specified by a path and point in the path. more details | Polyline | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Polyline | Inserts a new point into a polyline. more details | Polyline | |
Removes a group of handles owned by the object. more details | Accessor | ||
Point[] | Removes a path from the Polyline. more details | Polyline | |
Point | Removes a point from the polyline at the given | Polyline | |
Polyline | Updates a point in a polyline. more details | Polyline | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | Geometry |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(points){Polyline}
-
Adds a path, or line segment, to the polyline. When added, the index of the path is incremented by one.
ParameterA polyline path. This can either be defined as an array of Point geometries or an array of XY coordinates.
ReturnsType Description Polyline Returns the polyline with the new path included.
-
clone(){Polyline}
-
Creates a deep clone of Polyline object.
ReturnsType Description Polyline A 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 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
getPoint(pathIndex, pointIndex){Point}
-
Returns a point specified by a path and point in the path.
ParameterspathIndex NumberThe index of a path in the polyline.
pointIndex NumberThe index of a point in a path.
ReturnsType Description Point Returns the point along the Polyline located in the given path and point indices.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(pathIndex, pointIndex, point){Polyline}
-
Inserts a new point into a polyline.
ParameterspathIndex NumberThe index of the path in which to insert a point.
pointIndex NumberThe index of the inserted point in the path.
The point to insert.
ReturnsType Description Polyline Returns the updated polyline.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Removes a path from the Polyline. The index specifies which path to remove.
Parameterindex NumberThe index of the path to remove from the polyline.
ReturnsType Description 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 givenpathIndex
.ParameterspathIndex NumberThe index of the path containing the point to be removed.
pointIndex NumberThe index of the point to be removed within the path.
ReturnsType Description Point Returns the removed point.
-
setPoint(pathIndex, pointIndex, point){Polyline}
-
Updates a point in a polyline.
ParameterspathIndex NumberThe index of the path that contains the point to be updated.
pointIndex NumberThe index of the point to be updated in the path.
Point geometry to update in the path.
ReturnsType Description Polyline Returns the updated polyline.
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.