OffsetParameters

AMD: require(["esri/rest/support/OffsetParameters"], (OffsetParameters) => { /* code goes here */ });
ESM: import OffsetParameters from "@arcgis/core/rest/support/OffsetParameters";
Class: esri/rest/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.
Show inherited properties Hide inherited properties
Name Type Summary Class
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
OffsetParameters
String

The name of the class.

more details
Accessor
Geometry[]

The array of geometries to be offset.

more details
OffsetParameters
Number

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

more details
OffsetParameters
String

Options that determine how the ends intersect.

more details
OffsetParameters
String

The offset distance unit.

more details
OffsetParameters

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 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.

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

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

more details
OffsetParameters
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
OffsetParameters

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.