Description
A multipart linear shape.
AGSPolyline 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. They 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.
An AGSPolyline 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 AGSPolyline from a collection of AGSPoint to create a series of straight AGSLineSegment connecting the points you specified. You can use AGSPolylineBuilder to build a polyline one point at a time or to modify an existing AGSPolyline.
Additionally, AGSPolyline 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 then starts again a block later. Parts can also intersect at one or more vertices. For example, in a polyline representing a river and its tributaries. The AGSPolyline class inherits from AGSMultipart, which provides members for iterating the segments and points of each part in an AGSPolyline.
- Since
- 100
- Note
- This class represents an immutable polyline geometry, it cannot be modified after being created. Use
toBuilder (AGSPolyline):to get a polyline builder using a copy of this geometry as a starting off point. The builder can then be modified to produce a new geometry.
- See also
AGSPolylineBuilderto construct or modify polylines programmatically.-
AGSSketchEditorto construct or modify geometries interactively by sketching on a map. -
AGSGeometryEngineto perform operations on geometries.
Instance Methods | |
| (BOOL) | - isEqualToGeometry: |
| (BOOL) | - isEqualToGeometry: |
| (BOOL) | - isEqualToGeometry:tolerance: |
| (AGSPolylineBuilder *) | - toBuilder |
| (nullable id) | - toJSON: |
Class Methods | |
| (nullable id< AGSJSONSerializable >) | + fromJSON:error: |
| (instancetype) | + polylineWithPoints: |
Properties | |
| AGSGeometryDimension | dimension |
| BOOL | empty |
| AGSEnvelope * | extent |
| AGSGeometryType | geometryType |
| BOOL | hasCurves |
| BOOL | hasM |
| BOOL | hasZ |
| AGSPartCollection * | parts |
| AGSSpatialReference * | spatialReference |
| NSDictionary< NSString *, id > * | unknownJSON |
| NSDictionary< NSString *, id > * | unsupportedJSON |
Method Documentation
§ fromJSON:error:()
|
staticrequiredinherited |
Initializes and returns an object from its JSON representation.
- Parameters
-
JSONObject NSDictionaryorNSArraycontaining the JSON.error encountered during the operation, if any.
- Since
- 100
§ isEqualToGeometry:() [1/2]
| - (BOOL) isEqualToGeometry: | (AGSPolyline *) | other |
Compares whether two polyline geometries are equal.
- Parameters
-
other polyline to compare this polyline to
- Returns
- YES if the polylines are equal
- Since
- 100
§ isEqualToGeometry:() [2/2]
| - (BOOL) isEqualToGeometry: | (AGSGeometry *) | other |
Compares whether two geometries are equal.
- Parameters
-
other geometry to compare this geometry to
- Returns
- YES if the geometries are equal
- Since
- 100
§ isEqualToGeometry:tolerance:()
| - (BOOL) isEqualToGeometry: | (AGSGeometry *) | other | |
| tolerance: | (double) | tolerance | |
§ polylineWithPoints:()
| + (instancetype) polylineWithPoints: | (NSArray< AGSPoint * > *) | points |
Initializes a polyline.
- Parameters
-
points for the geometry to be constructed
- Since
- 100
§ toBuilder()
| - (AGSPolylineBuilder*) toBuilder |
Returns a builder using a copy of this geometry as a starting off point. The builder can then be modified to produce a new geometry.
- Returns
- builder that can be used to build polyline geometries.
- Since
- 100
- Note
- Operations on the builder affect only its own internal copy of the geometry. They do not affect this geometry.
Implements AGSGeometry.
§ toJSON:()
|
requiredinherited |
Returns JSON representation for this object.
- Parameters
-
error encountered during the operation, if any.
- Returns
NSDictionaryorNSArraycontaining the JSON.
- Since
- 100
Reimplemented in AGSPortalItem.
Property Documentation
§ dimension
|
readnonatomicassigninherited |
§ empty
|
readnonatomicassigninherited |
Indicates whether this geometry has any vertices.
- Since
- 100
§ extent
|
readnonatomicstronginherited |
Smallest, rectangular bounding-box that covers the geometry.
- Since
- 100
§ geometryType
|
readnonatomicassigninherited |
The type of this geometry.
- Since
- 100
§ hasCurves
|
readnonatomicassigninherited |
Indicates whether this geometry has curves.
- Since
- 100
§ hasM
|
readnonatomicassigninherited |
Indicates whether this geometry contains m (measure) values.
- Since
- 100
§ hasZ
|
readnonatomicassigninherited |
Indicates whether this geometry contains z coordinate values. Only 3D geometries contain z values.
- Since
- 100
§ parts
|
readnonatomicstronginherited |
The parts of this geometry.
Can be iterated through a for-in loop.
- Since
- 100
§ spatialReference
|
readnonatomicstronginherited |
The spatial reference associated with the gometry. It specifies the coordinate system for the geometry's x, y, and z coordinate values.
- Since
- 100
- Note
- Geometries that represent geographic locations should always have a spatial reference. Otherwise the coordinates of the geometry are meaningless.
§ unknownJSON
|
readrequirednonatomiccopyinherited |
A dictionary of values that was in the source JSON but was unparsed by API.
- Returns
NSDictionarycontaining the unknown JSON.
- Since
- 100
§ unsupportedJSON
|
readnonatomiccopyinherited |
A dictionary of values that are supported by the REST API, but not exposed through the SDK API.
- Returns
NSDictionarycontaining the unsupported JSON.
- Since
- 100
