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

SketchTooltipOptions Constructor new SketchTooltipOptions(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

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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

enabled Property enabled Boolean

Whether tooltips are shown while sketching and editing.

Default Value:false

inputEnabled Property inputEnabled Boolean

Whether users can focus the tooltip and input editing constraint values.

Default Value:true

visibleElements Property visibleElements VisibleElementsautocast

The elements that are displayed within the tooltip while sketching.

Method Overview

Show inherited methods

Hide inherited methods

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

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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");

Type Definitions

VisibleElements Type Definition VisibleElements

The elements that are displayed within the tooltip while sketching and editing.

Properties: area Boolean

optional
Default Value:true

When set to false, the area is not shown in the tooltip.

direction Boolean

optional
Default Value:true

When set to false, the direction (or deflection angle) is not shown in the tooltip.

distance Boolean

optional
Default Value:true

When set to false, the distance is not shown in the tooltip.

elevation Boolean

optional
Default Value:true

When set to false, the elevation is not shown in the tooltip.

header Boolean

optional
Default Value:true

When set to false, the header at the top of the tooltip is not shown, when in input mode.

helpMessage Boolean

optional
Default Value:false

When set to false, the help message at the bottom of the tooltip is not shown.

orientation Boolean

optional
Default Value:true

When set to false, the orientation is not shown in the tooltip.

radius Boolean

optional
Default Value:true

When set to false, the radius is not shown in the tooltip.

rotation Boolean

optional
Default Value:true

When set to false, the rotation is not shown in the tooltip.

scale Boolean

optional
Default Value:true

When set to false, the scale is not shown in the tooltip.

size Boolean

optional
Default Value:true

When set to false, the size is not shown in the tooltip.

totalLength Boolean

optional
Default Value:true

When set to false, the total length is not shown in the tooltip.

ArcGIS Maps SDK for JavaScriptAPI Reference

Constructors

SketchTooltipOptions

Property Overview

Property Details

declaredClass

enabled

inputEnabled

visibleElements

Method Overview

Method Details

addHandles

hasHandles

removeHandles

Type Definitions

VisibleElements

Was this page helpful?