ESM: import Polyline from "@arcgis/core/geometry/Polyline.js";
CDN: const Polyline = await $arcgis.import("@arcgis/core/geometry/Polyline.js");
Class: @arcgis/core/geometry/Polyline
Since: ArcGIS Maps SDK for JavaScript 4.0
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property cache Objectreadonly
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.
Inherited
Property declaredClass Stringreadonly
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.
The extent of the geometry. For a point, the extent is null.
Inherited
Property hasM Boolean
Indicates if the geometry has M values.
Inherited
Property hasZ Boolean
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.
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:SpatialReference.WGS84 // wkid: 4326
type Stringreadonly
For Polyline the type is always "polyline".
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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.
Parameter
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.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().
Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Returns a point specified by a path and point in the path.
Parameters
The index of a path in the polyline.
The index of a point in a path.
Returns
Type Description Point | null | undefined Returns the point along the Polyline located in the given path and point indices.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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.
Parameters
The index of the path in which to insert a point.
The index of the inserted point in the path.
The point to insert.
Returns
Type Description Polyline Returns the updated polyline.Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Removes a path from the Polyline. The index specifies which path to remove.
Parameter
The index of the path to remove from the polyline.
Returns
Type Description Point[] | null | undefined Returns an array of points representing the removed path.Removes a point from the polyline at the given pointIndex within the path identified by the given pathIndex.
Parameters
The index of the path containing the point to be removed.
The index of the point to be removed within the path.
Returns
setPoint(pathIndex, pointIndex, point){Polyline}
Updates a point in a polyline.
Parameters
The index of the path that contains the point to be updated.
The index of the point to be updated in the path.
Point geometry to update in the path.
Returns
Type Description Polyline Returns the updated polyline.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4