TrimExtendParameters | References | ArcGIS Maps SDK for JavaScript

import TrimExtendParameters from "@arcgis/core/rest/support/TrimExtendParameters.js";

Inheritance:: TrimExtendParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

Used to set the parameters for the trimExtend() operation.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TrimExtendParametersProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`extendHow`	`"default-curve-extension" \| "relocate-ends" \| "keep-end-attributes" \| "no-end-attributes" \| "no-extend-at-from" \| "no-extend-at-to"`
`polylines`	`Polyline[] \| null \| undefined`
`trimExtendTo`	`Polyline \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

extendHow

Property

Type: "default-curve-extension" | "relocate-ends" | "keep-end-attributes" | "no-end-attributes" | "no-extend-at-from" | "no-extend-at-to"

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.

Default value: "default-curve-extension"

polylines

autocast Property

Type: Polyline[] | null | undefined

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

autocast Property

Type: Polyline | null | undefined

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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.