TrimExtendParameters

AMD: require(["esri/rest/support/TrimExtendParameters"], (TrimExtendParameters) => { /* code goes here */ });
ESM: import TrimExtendParameters from "@arcgis/core/rest/support/TrimExtendParameters";
Class: esri/rest/support/TrimExtendParameters
Inheritance: TrimExtendParameters Accessor
Since: ArcGIS API for JavaScript 4.20

Used to set the parameters for 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

A flag used with the trimExtend operation.

more detailsTrimExtendParameters
Polyline[]more details

The array of polylines to trim or extend.

more detailsTrimExtendParameters
Polylinemore details

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

more detailsTrimExtendParameters

Property Details

declaredClass Stringreadonly inherited

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"
polylines Polyline[]

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
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsTrimExtendParameters
Objectmore details

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

more detailsTrimExtendParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.