require(["esri/rest/support/OffsetParameters"], (OffsetParameters) => { /* code goes here */ });
import OffsetParameters from "@arcgis/core/rest/support/OffsetParameters.js";
esri/rest/support/OffsetParameters
Sets the offset distance, type and other parameters for the geometryService.offset operation.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The | OffsetParameters | ||
The name of the class. | Accessor | ||
The array of geometries to be offset. | OffsetParameters | ||
Specifies the planar distance for constructing an offset based on the input geometries. | OffsetParameters | ||
Options that determine how the ends intersect. | OffsetParameters | ||
The offset distance unit. | OffsetParameters |
Property Details
-
bevelRatio
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 forbevelRatio
is ignored and10
is used internally. If beveled is specified,1.1
will be used if no value is set for bevelRatio. The bevelRatio is ignored whenrounded
is specified.
-
offsetDistance
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
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
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | OffsetParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | OffsetParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.