extendOperator | References | ArcGIS Maps SDK for JavaScript

import { execute, supportsCurves } from "@arcgis/core/geometry/operators/extendOperator.js";

Since: ArcGIS Maps SDK for JavaScript 4.31

Extend 2D polylines with a polyline.

By default, this considers both ends of parts. The old ends remain and new points are added at the extended ends. The new points have attributes that are extrapolated from adjacent existing segments.

Type definitions

Options

Type definition

relocateEnds

Property

Type: boolean | undefined

If an extension is performed at an end, relocate the end point to the new position instead of leaving the old point and adding a new point at the new position.

keepEndAttributes

Property

Type: boolean | undefined

If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes the same as the current end. Incompatible with noEndAttributes.

noEndAttributes

Property

Type: boolean | undefined

If an extension is performed at an end, do not extrapolate the end-segment's attributes for the new point. Instead, make its attributes empty. Incompatible with keepEndAttributes.

noExtendAtFrom

Property

Type: boolean | undefined

Do not extend the 'from' end of any part.

noExtendAtTo

Property

Type: boolean | undefined

Do not extend the 'to' end of any part.

Functions

Name	Return Type	Object
`Options`
`execute`	`Polyline \| null \| undefined`
`supportsCurves`

execute

Function

Performs the extend operation on a polyline using a polyline as the extender.

Signature: execute (polyline1: Polyline, polyline2: Polyline, options?: Options): Polyline | null | undefined

Parameters

Parameter	Type	Description
polyline1	`Polyline`	The polyline to be extended.
polyline2	`Polyline`	The polyline to extend to.
options	`Options`	Additional options.

Returns: Polyline | null | undefined
Returns the extended polyline or null. The output polyline will have the first and last segment of each path extended to polyline2 if the segments can be interpolated to intersect it. In the case that the segments can be extended to multiple segments of the extender, polyline2, the shortest extension is chosen. Only end points for paths that are not shared by the end points of other paths will be extended. If the polyline cannot be extended, then null is returned.

Variables

supportsCurves

Variable

Indicates if the operator supports input geometries that contain curves. The value will always be false.

Type: boolean