OffsetParameters | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: OffsetParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

Sets the offset distance, type and other parameters for the offset() operation.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`OffsetParametersProperties`

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
`bevelRatio`	`number \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`geometries`	`GeometryUnion[] \| null \| undefined`
`offsetDistance`	`number \| null \| undefined`
`offsetHow`	`"bevelled" \| "mitered" \| "rounded" \| null \| undefined`
`offsetUnit`	`GeometryOperationLengthUnit \| null \| undefined`

bevelRatio

Property

Type: number | null | undefined

The bevelRatio is multiplied by the offset distance and the result determines how far a mitered offset intersection can be located before it is beveled. When mitered is specified, the value set for bevelRatio is ignored and 10 is used internally. If beveled is specified, 1.1 will be used if no value is set for bevelRatio. The bevelRatio is ignored when rounded is specified.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

geometries

Property

Type: GeometryUnion[] | null | undefined

The array of geometries to be offset.

offsetDistance

Property

Type: number | null | undefined

Specifies the planar distance for constructing an offset based on the input geometries. If the offsetDistance parameter is positive, the constructed offset will be on the right side of the curve. Left side offsets are constructed with negative values.

offsetHow

Property

Type: "bevelled" | "mitered" | "rounded" | null | undefined

Options that determine how the ends intersect. Set to one of the following options:

Possible Value	Description
bevelled	Squares off the corner after a given ratio distance.
mitered	Attempts to allow extended offsets to naturally intersect. If the intersection occurs too far from a corner, the corner will be beveled off at a fixed distance.
rounded	Rounds the corner between extended offsets.

offsetUnit

Property

Type: GeometryOperationLengthUnit | null | undefined

The offset distance unit. For a list of valid units see esriSRUnitType constants or esriSRUnit2Type constants.

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.