Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: Polyline
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.geometry.Polyline")
Description
(Added at v1.0)
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
| Name | Summary |
|---|---|
| new esri.geometry.Polyline(spatialReference) | Creates a new Polyline object. |
| new esri.geometry.Polyline(json) | Creates a new Polyline object using a JSON object. |
| new esri.geometry.Polyline(coordinates) | Create a new polyline by providing an array of geographic coordinates. |
Properties
| Name | Type | Summary |
|---|---|---|
| cache | Object | The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. |
| paths | Number[][][] | An array of paths. |
| spatialReference | SpatialReference | The spatial reference of the geometry. |
| type | String | The type of geometry. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addPath(path) | Polyline | Adds a path to the Polyline. |
| clearCache() | None | Sets the cache property to undefined. |
| getCacheValue(name) | Object | Returns the value for a named property stored in the cache. |
| 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. |
| removePoint(pathIndex, pointIndex) | Point | Remove a point from the polyline at the given pointIndex within the path identified by the given pathIndex. |
| setCacheValue(name, value) | None | Sets the value for a named property stored in the cache. |
| setPoint(pathIndex, pointIndex, point) | Polyline | Updates a point in a polyline. |
| setSpatialReference(sr) | Geometry | Sets the spatial reference. |
| toJson() | Object | Converts object to its ArcGIS Server JSON representation. |
Constructor Details
Creates a new Polyline object.
Parameters:
< |
Required | Spatial reference of the geometry. |
Sample:
new esri.geometry.Polyline(new esri.SpatialReference({wkid:4326}));
Creates a new Polyline object using a JSON object.
Parameters:
< |
Required | JSON object representing the geometry. |
Sample:
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);
Create a new polyline by providing an array of geographic coordinates. For a single path polyline provide an array of coordinate pairs. For a multi-path polyline provide an array of array coordinate pairs. (Added at v3.6)
Parameters:
< |
Required | An array of geographic coordinates that define the polyline. |
Property Details
<Object
ObjectThe 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
undefined. (Added at v3.13)Default value:
undefined<Number[][][]
Number[][][]An array of paths. Each path is made up of an array of two or more points.
See also: addPath()
<SpatialReference
SpatialReferenceThe 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. When added the index of the path is incremented by one.
Return type:
PolylineParameters:
< |
Required | Path to add to the Polyline. Can be one of the following: an array of numbers or an array of points. |
Sample:
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 the value for a named property stored in the cache. (Added at v3.13)
Return type:
ObjectParameters:
< |
Required | The property name of the value to retrieve from the cache. |
Returns a point specified by a path and point in the path.
Return type:
PointInserts a new point into a polyline. (Added at v1.4)
Return type:
PolylineRemoves a path from the Polyline. The index specifies which path to remove.
Return type:
Point[]Parameters:
< |
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. (Added at v2.0)
Return type:
PointSets the value for a named property stored in the cache. (Added at v3.13)
Updates a point in a polyline. (Added at v1.4)
Return type:
PolylineSets the spatial reference.
Return type:
GeometryParameters:
< |
Required | Spatial reference of the geometry. |