Polyline
A multipart linear shape. Polyline geometries represent the shape and location of linear features, such as a street in a road network, a contour line representing an elevation value, or a hiking trail. A polyline can be used to define geometry for features and graphics, or as input or output for tasks or geoprocessing operations, such as the output of a network trace.
A polyline can be used as the geometry of a Feature or Graphic. To obtain the geometry on these objects, use GeoElement.geometry.
A polyline is composed of a series of connected segments, where each Segment defines a continuous line between a start and an end point. You can define a new polyline from a collection of Point objects to create a series of straight LineSegment objects connecting the points you specified. You can use PolylineBuilder to build a polyline one point at a time, or to modify an existing polyline.
A polyline can have multiple parts. Each part is a series of connected segments, but the parts can be disjoint, for example, a polyline representing a street that ends, and starts again a block later. Parts can also intersect at one or more points (or vertices), for example, a polyline representing a river and its tributaries.
Polylines inherit from Multipart, which provides members for iterating the segments and points of each part in a polyline.
Polylines are based upon the parent Geometry class which is immutable, meaning you can not change its shape once it is created. If you need to modify a polyline once it has been created, use the PolylineBuilder class.
Since
200.1.0
See also
Constructors
Constructs a Polyline with the given list of MutablePart.
Constructs a Polyline with the given collection of Points.
Inherited properties
The number of dimensions for the geometry. Returns GeometryDimension.Unknown if an error occurs.
True if this geometry contains curve segments; false otherwise. ArcGIS software supports polygon and polyline geometries that contain curve segments (where Segment.isCurve is true, sometimes known as true curves or nonlinear segments). Curves may be present in certain types of data - for example Mobile Map Packages (MMPK) or geometry JSON. When connecting to ArcGIS feature services that support curves[ArcGISFeatureServiceInfo.supportsTrueCurve], this API retrieves densified versions of curve feature geometries by default.
Inherited functions
Check if two geometries are equal to within some tolerance. This function performs a lightweight comparison of two geometries, such as might be useful when writing test code. It uses the tolerance to compare each of x, y, and any other values the geometries possess (such as z or m) independently in the manner: abs(value1 - value2) <= tolerance. Returns true if the difference of each is within the tolerance and all other properties of the geometries are exactly equal (spatial reference, vertex count, etc.). A single tolerance is used even if the units for the horizontal coordinates and other values differ, e.g horizontal coordinates in degrees and vertical coordinates in meters. This function does not respect modular arithmetic of spatial references which wrap around, so longitudes of -180 and +180 degrees are considered to differ by 360 degrees. Returns false if an error occurs. For topological equality, use relational operators instead of this function. See GeometryEngine.equals(Geometry, Geometry).