Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: Polyline
[ AMD Module Require | Legacy Module Require ]
Description
An array of paths where each path is an array of points.
Samples
Search for samples that use this class.Class hierarchy
esri.geometry.Geometry |_esri.geometry.Polyline
Constructors
| Constructor | Description |
|---|---|
| new esri.geometry.Polyline(spatialReference) | Creates a new Polyline object. |
| new esri.geometry.Polyline(json) | Creates a new Polyline object using a JSON object. |
Properties
| Property | Type | Description |
|---|---|---|
| paths | Number[][][] | An array of paths. Each path is made up of an array of two or more points. |
| spatialReference | SpatialReference | The spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references. |
| type | String | The type of geometry. |
Methods
| Method | Return Value | Description |
|---|---|---|
| addPath() | Polyline | Adds a path to the Polyline. The path can be one of the following: an array of numbers, an array of points, or a JSON object. When added the index of the path is incremented by one. The return value of Polyline was added at v1.4. |
| getExtent() | Extent | Returns the extent of the Polyline. |
| getPoint(pathIndex,pointIndex) | Point | Returns a point specified by a path and point in the path. |
| insertPoint(pathIndex,pointIndex,point) | Polyline | Inserts a new point into a polyline. |
| removePath(pathIndex) | Point[] | Removes a path from the Polyline. The index specifies which path to remove. |
| removePoint(pathIndex,pointIndex) | Point | Remove a point from the polyline at the given pointIndex within the path identified by the given pathIndex. |
| setPoint(pathIndex,pointIndex,point) | Polyline | Updates a point in a polyline. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. The return value of Geometry was added at v1.4. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new Polyline object.
Parameters:
| <SpatialReference> spatialReference | Required | Spatial reference of the geometry. |
Code Snippet:
new esri.geometry.Polyline(new esri.SpatialReference({wkid:4326}));
Creates a new Polyline object using a JSON object.
Parameters:
| <Object> json | Required | JSON object representing the geometry. |
Code Snippet:
var polylineJson = {
"paths":[[[-122.68,45.53], [-122.58,45.55],
[-122.57,45.58],[-122.53,45.6]]],
"spatialReference":{"wkid":4326}
};
var polyline = new esri.geometry.Polyline(polylineJson);
Property Details
An array of paths. Each path is made up of an array of two or more points.
See Also: addPath
<SpatialReference> spatialReference
The spatial reference of the geometry. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
Method Details
Adds a path to the Polyline. The path can be one of the following: an array of numbers, an array of points, or a JSON object. When added the index of the path is incremented by one.
The return value of
The return value of
Polyline was added at v1.4.Return Value: Polyline
Code Snippet:
Adding a path using Points:
polyline.addPath([new esri.geometry.Point(10,10), new esri.geometry.Point(20,20), new esri.geometry.Point(30,30)]);
Adding a path using an array of x,y coordinate pairs:
polyline.addPath([[-122.68,45.53], [-122.58,45.55], [-122.57,45.58],[-122.53,45.60]]);
See Also: paths
Returns a point specified by a path and point in the path.
Return Value: Point
Input Parameters:
| <Number> pathIndex | Required | The index of a path in a polyline. |
| <Number> pointIndex | Required | The index of a point in a path. |
Inserts a new point into a polyline.
Return Value: Polyline
Input Parameters:
| <Number> pathIndex | Required | Path index to insert point. |
| <Number> pointIndex | Required | The index of the inserted point in the path. |
| <Point> point | Required | Point to insert into the path. |
Removes a path from the Polyline. The index specifies which path to remove.
Return Value: Point[]
Input Parameters:
| <Number> pathIndex | Required | The index of a path to remove. |
Remove a point from the polyline at the given pointIndex within the path identified by the given pathIndex.
Return Value: Point
Input Parameters:
| <Number> pathIndex | Required | The index of the path containing the point. |
| <Number> pointIndex | Required | The index of the point within the path. |
Updates a point in a polyline.
Return Value: Polyline
Input Parameters:
| <Number> pathIndex | Required | Path index for updated point. |
| <Number> pointIndex | Required | The index of the updated point in the path. |
| <Point> point | Required | Point to update in the path. |
Sets the spatial reference.
The return value of
The return value of
Geometry was added at v1.4.Return Value: Geometry
Input Parameters:
| <SpatialReference> sr | Required | Spatial reference of the geometry. |