require(["esri/views/interactive/sketch/SketchTooltipOptions"], (SketchTooltipOptions) => { /* code goes here */ });
import SketchTooltipOptions from "@arcgis/core/views/interactive/sketch/SketchTooltipOptions.js";
esri/views/interactive/sketch/SketchTooltipOptions
The SketchTooltipOptions
allows users to configure the tooltips which are shown while
sketching and editing.
To enter the tooltip UI's input mode,
press the Tab
key while actively drawing.
- 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 |
---|---|---|---|
String | The name of the class. | Accessor | |
Boolean | Whether tooltips are shown while sketching and editing. | SketchTooltipOptions | |
Boolean | Whether users can focus the tooltip and input editing constraint values. | SketchTooltipOptions | |
VisibleElements | The elements that are displayed within the tooltip while sketching. | SketchTooltipOptions |
Property Details
-
enabled
enabled Boolean
-
Whether tooltips are shown while sketching and editing.
- Default Value:false
-
inputEnabled
inputEnabled Boolean
-
Whether users can focus the tooltip and input editing constraint values.
- Default Value:true
-
visibleElements
visibleElements VisibleElementsautocast
-
The elements that are displayed within the tooltip while sketching.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Boolean | 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
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.
-
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");
Type Definitions
-
The elements that are displayed within the tooltip while sketching and editing.
- Properties
-
area BooleanDefault Value:true
When set to
false
, the area is not shown in the tooltip.direction BooleanDefault Value:trueWhen set to
false
, the direction (or deflection angle) is not shown in the tooltip.distance BooleanDefault Value:trueWhen set to
false
, the distance is not shown in the tooltip.elevation BooleanDefault Value:trueWhen set to
false
, the elevation is not shown in the tooltip.header BooleanDefault Value:trueWhen set to
false
, the header at the top of the tooltip is not shown, when in input mode.helpMessage BooleanDefault Value:falseWhen set to
false
, the help message at the bottom of the tooltip is not shown.orientation BooleanDefault Value:trueWhen set to
false
, the orientation is not shown in the tooltip.radius BooleanDefault Value:trueWhen set to
false
, the radius is not shown in the tooltip.rotation BooleanDefault Value:trueWhen set to
false
, the rotation is not shown in the tooltip.scale BooleanDefault Value:trueWhen set to
false
, the scale is not shown in the tooltip.size BooleanDefault Value:trueWhen set to
false
, the size is not shown in the tooltip.totalLength BooleanDefault Value:trueWhen set to
false
, the total length is not shown in the tooltip.