TrimExtendParameters

require(["esri/tasks/support/TrimExtendParameters"], function(TrimExtendParameters) { /* code goes here */ });
Class: esri/tasks/support/TrimExtendParameters
Inheritance: TrimExtendParameters Accessor
Since: ArcGIS API for JavaScript 4.0

Used to set the parameters for the the GeometryService.trimExtend operation.

See also:

Constructors

new TrimExtendParameters(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

A flag used with the trimExtend operation.

more details
more detailsTrimExtendParameters
Polyline[]

The array of polylines to trim or extend.

more details
more detailsTrimExtendParameters
Polyline

A polyline used as a guide for trimming or extending input polylines.

more details
more detailsTrimExtendParameters

Property Details

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

extendHowString

A flag used with the trimExtend operation.

Possible ValueDescription
default-curve-extensionDefault. The extension considers both ends of the path. The old ends remain and new points are added to the extended ends. The new points have attributes that are extrapolated from existing adjacent segments.
relocate-endsWhen an extension is performed at an end, relocate the end point to the new position.
keep-end-attributesWhen an extension is performed at an end, do not extrapolate the end segments attributes for the new point. Instead, the attributes will be the same as the current end.
no-end-attributesWhen an extension is performed at an end, do not extrapolate the end segments attributes for the new point. Instead the attributes will be empty.
no-extend-at-fromDo not extend the 'from' end of any path.
no-extend-at-toDo not extend the 'to' end of any path.

polylinesPolyline[]

The array of polylines to trim or extend. The structure of each geometry in the array is the same as the structure of the JSON polyline objects returned by the ArcGIS REST API.

trimExtendToPolyline

A polyline used as a guide for trimming or extending input polylines. The structure of the polyline is the same as the structure of the JSON polyline object returned by the ArcGIS REST API.

Method Overview

NameReturn TypeSummaryClass
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsTrimExtendParameters

Method Details

toJSON(){Object}

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.