require(["esri/views/interactive/sketch/SketchValueOptions"], (SketchValueOptions) => { /* code goes here */ });
import SketchValueOptions from "@arcgis/core/views/interactive/sketch/SketchValueOptions.js";
esri/views/interactive/sketch/SketchValueOptions
The SketchValueOptions allows users to configure how numerical values and
constraints behave while sketching and editing.
- See also
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 name of the class. | Accessor | ||
How direction values are displayed and, in case of input, how they are interpreted. | SketchValueOptions | ||
Units used for displaying values in the UI. | SketchValueOptions | ||
Units used for interpreting input values. | SketchValueOptions |
Property Details
-
directionMode
PropertydirectionMode String -
How direction values are displayed and, in case of input, how they are interpreted.
- When set to "relative", the direction (also called deflection) is measured relative to the previous segment.
Positive values are measured in a clockwise direction. Negative values are measured in a counterclockwise direction. - When set to "absolute", the direction is measured clockwise from the main axis of the map (typically north).
The direction mode can be toggled in the tooltip’s UI, provided the input mode is active.
Possible Values:"relative" |"absolute"
- Default Value:"relative"
- When set to "relative", the direction (also called deflection) is measured relative to the previous segment.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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
-
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");
Type Definitions
-
Units used for displaying or interpreting values in the UI.
- Properties
-
optionallength SystemOrLengthUnit|null|undefinedDefault Value:null
Length units.
optionalverticalLength SystemOrLengthUnit|null|undefinedDefault Value:nullVertical length units.
optional Default Value:nullArea units.