Skip To ContentArcGIS for DevelopersSign In Dashboard

OffsetParameters

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

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

See also:

Constructors

new OffsetParameters(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
Number

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.

more details
more detailsOffsetParameters
String

The name of the class.

more details
more detailsAccessor
Geometry[]

The array of geometries to be offset.

more details
more detailsOffsetParameters
Number

Specifies the planar distance for constructing an offset based on the input geometries.

more details
more detailsOffsetParameters
String

Options that determine how the ends intersect.

more details
more detailsOffsetParameters
String

The offset distance unit.

more details
more detailsOffsetParameters

Property Details

bevelRatio Number

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 Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

geometries Geometry[]

The array of geometries to be offset.

offsetDistance Number

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 String

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

Possible ValueDescription
bevelledSquares off the corner after a given ratio distance.
miteredAttempts 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.
roundedRounds the corner between extended offsets.

Possible Values:"bevelled"|"mitered"|"rounded"

offsetUnit String

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

Possible Values:"feet"|"kilometers"|"meters"|"miles"|"nautical-miles"|"yards"

Method Overview

NameReturn TypeSummaryClass
*

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

more details
more detailsOffsetParameters
Object

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

more details
more detailsOffsetParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...