• esri/views


AMD: require(["esri/views/interactive/sketch/SketchLabelOptions"], (SketchLabelOptions) => { /* code goes here */ });
ESM: import SketchLabelOptions from "@arcgis/core/views/interactive/sketch/SketchLabelOptions";
Class: esri/views/interactive/sketch/SketchLabelOptions
Inheritance: SketchLabelOptions Accessor
Since: ArcGIS API for JavaScript 4.24

The SketchLabelOptions allows users to configure the labels which are shown next to each segment of a graphic while sketching and editing.


Known Limitation

Sketch labels are currently only supported when working with a SceneView.

See also:


new SketchLabelOptions(properties)
properties Object

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
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Whether labels are shown next to each segment of the graphic being sketched.

more detailsSketchLabelOptions

Property Details

declaredClass Stringreadonly inherited

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

enabled Boolean

Whether labels are shown next to each segment of the graphic being sketched.

Default Value:false

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.