TrimExtendParameters
require(["esri/tasks/support/TrimExtendParameters"], function(TrimExtendParameters) { /* code goes here */ });
esri/tasks/support/TrimExtendParameters
Used to set the parameters for the GeometryService.trimExtend operation.
Constructors
- new TrimExtendParameters(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
String | A flag used with the | more details | TrimExtendParameters | |
Polyline[] | The array of polylines to trim or extend. more details | more details | TrimExtendParameters | |
Polyline | A polyline used as a guide for trimming or extending input polylines. more details | more details | TrimExtendParameters |
Property Details
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- extendHow String
A flag used with the
trimExtend
operation.Possible Value Description default-curve-extension 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-ends When an extension is performed at an end, relocate the end point to the new position. keep-end-attributes When 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-attributes When 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-from Do not extend the 'from' end of any path. no-extend-at-to Do not extend the 'to' end of any path. Possible Values:"default-curve-extension"|"relocate-ends"|"keep-end-attributes"|"no-end-attributes"|"no-extend-at-from"|"no-extend-at-to"
- Default Value:"default-curve-extension"
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.
- trimExtendTo Polyline
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | TrimExtendParameters |
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:Type Description Object The ArcGIS portal JSON representation of an instance of this class.