ESM: import Sketch from "@arcgis/core/widgets/Sketch.js";
CDN: const Sketch = await $arcgis.import("@arcgis/core/widgets/Sketch.js");
Class: @arcgis/core/widgets/Sketch
Since: ArcGIS Maps SDK for JavaScript 4.10
Sketch widget provides a simple UI for creating and updating graphics on a MapView or a SceneView. This significantly minimizes the code required for working with graphics in the view. It is intended to be used with graphics stored in its layer property.
By default, the Sketch widget provides out-of-the-box tools for creating and updating graphics with point, polyline, polygon, rectangle and circle geometries.
Discover the Sketch widget in MapView with this sample:
Discover the Sketch widget in SceneView with this sample:
Note that the update operations (such as rotate, move, and transform) and the creation of rectangles and circles happen in the map space. This means that, for example, if a graphic is rotated in a Web Mercator view, its shape and segment lengths change.
Pointer and keyboard gesturesPointer and keyboard gestures for creating graphics with different geometries are described in the tables below.
General shortcuts Creating point graphics Gesture Action Left-click Adds a point graphic at the pointer location. Enter Adds a point graphic at the pointer location. Creating polyline and polygon graphicsThe following keyboard shortcuts apply when creating polyline and polygon graphics.
Creating polygon graphics with predefined shapesThe following keyboard shortcuts apply when creating polygon graphics with predefined shapes (rectangle and circle).
The Sketch widget provides users with the ability to move, rotate, scale or reshape graphics during an update operation. To begin updating, Left-click on a graphic. Use Shift+Left-click to add more graphics to the selection, or remove graphics from the selection, for bulk updating. Once graphics are selected, the following actions can be performed.
The following update operations can be performed on a single polyline or polygon graphic:
The following update operations can be performed on a single graphic with point geometry in a SceneView, if the graphic uses a 3D object symbol layer:
Sketch 3DTo be able to manipulate features on the z-axis using the height handle, the following configurations are relevant:
absolute-height, relative-to-sceneor relative-to-ground.hasZ needs to be true in defaultCreateOptions and/or in the createOptions.enableZ needs to be true in defaultUpdateOptions and/or in the updateOptions.// define the GraphicsLayer
const gLayer = new GraphicsLayer({
elevationInfo: {
mode: "absolute-height" // default value
}
});
// define the SketchViewModel
const sketchVM = new SketchViewModel({
layer: gLayer,
view: view,
defaultCreateOptions: {
hasZ: true // default value
},
defaultUpdateOptions: {
enableZ: true // default value
}
});
In absolute-height elevation mode, the sketched vertices snap to scene elements (features and ground). See elevation info for more information on how z-values are used with different elevation modes.
When sketching polygons or polylines, the elevation constraint is applied by default. This means that all the vertices use the z-value of the first vertex. To unlock the elevation constraint while sketching, enable the tooltips in the widget's "Settings" menu and press Tab to activate the input mode while drawing or updating a feature.
Note that in elevation modes other than absolute-height the z-values are fixed but the graphic may appear non-planar because of the elevation alignment applied to the vertices.
See more about available tooltip inputs and constraints under the tooltip options class.
Known Limitation
Multipoint geometry can only be created in a MapView.
Example
// Create a new instance of sketch widget and set its required parameters
let sketch = new Sketch({
layer: graphicsLayer,
view: view
});
// Listen to sketch widget's create event.
sketch.on("create", function(event) {
// check if the create event's state has changed to complete indicating
// the graphic create operation is completed.
if (event.state === "complete") {
// remove the graphic from the layer. Sketch adds
// the completed graphic to the layer by default.
graphicsLayer.remove(event.graphic);
// use the graphic.geometry to query features that intersect it
selectFeatures(event.graphic.geometry);
}
}); new Sketch(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Example
// typical usage
let sketch = new Sketch({
layer: layer,
view: view
});Show inherited properties Hide inherited properties
Property DetailsWhen creating new graphics (for example after create() has been called), this property reflects the create tool being used. When updating graphics (for example after update() has been called), this property reflects the update tool being used. If no create or update operation is in progress, this is null.
Prior to 4.32, creation tools were modeled as a combination of a geometry type (point, line, polygon) and an interaction mode (click, freehand, hybrid). At 4.32, the available create tools were expanded to include "freehandPolyline" and "freehandPolygon". These tools are made available to enable interoperability with other components of the ArcGIS system, where freehand polyline is a distinct create tool from polyline.
To minimize compatibility issues, if "freehandPolyline" and "freehandPolygon" are not in the list of available create tools, they will not be returned by this property, even if the user is drawing a polygon in freehand mode.
To opt in to freehandPolyline and freehandPolygon tools, include them when setting availableCreateTools, and visibleElements.createTools.
Possible Values:"point" |"polyline" |"polygon" |"freehandPolyline" |"freehandPolygon" |"multipoint" |"mesh" |"circle" |"rectangle" |"move" |"transform" |"reshape" |"rectangle-selection" |"lasso-selection" |"custom-selection"
Since: ArcGIS Maps SDK for JavaScript 4.31 Sketch since 4.10, activeTooltip added at 4.31.
The tooltip currently being displayed for the activeTool.
Since: ArcGIS Maps SDK for JavaScript 4.12 Sketch since 4.10, availableCreateTools added at 4.12.
Property controlling the visibility and order of create tool buttons.
Possible Values:"point" |"polyline" |"polygon" |"rectangle" |"circle" |"multipoint" |"freehandPolyline" |"freehandPolygon" |"mesh"
Default Value:["point", "polyline", "polygon", "rectangle", "circle"]
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: document.createElement("div")
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: basemapGalleryDiv
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});
// HTML markup
<body>
<div id="viewDiv"></div>
<div id="basemapGalleryDiv"></div>
</body>// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
view: view
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});The graphic that is being created.
creationMode String
Since: ArcGIS Maps SDK for JavaScript 4.14 Sketch since 4.10, creationMode added at 4.14.
Defines the default behavior once the create operation is completed. By default, the user will be able to continuously create graphics with same geometry types.
Possible Values
Value Description continuous This is the default. Users can continue creating graphics with same geometry types. single User can create a single graphic with the specified geometry type. User must choose an operation once the graphic is created. update The graphic will be selected for an update operation once thecreate operation is completed.
Possible Values:"single" |"continuous" |"update"
Default Value:"continuous"
Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
defaultCreateOptions Object
Since: ArcGIS Maps SDK for JavaScript 4.14 Sketch since 4.10, defaultCreateOptions added at 4.14.
Default create options set for the Sketch widget.
The default z-value of the newly created geometry. Ignored when hasZ is false or the layer's elevation mode is set to absolute-height.
Controls whether the created geometry has z-values or not.
mode String optionalCreate operation mode how the graphic can be created.
Value Description hybrid Vertices are added while the pointer is clicked or dragged. Applies topolygon and polyline. freehand Vertices are added while the pointer is dragged. Applies to polygon, polyline rectangle and circle. Default for rectangle and circle. click Vertices are added when the pointer is clicked. Applies to polygon, polyline rectangle and circle. Default for polygon and polyline.
Possible Values:"hybrid"|"freehand"|"click"
preserveAspectRatio Boolean optionalControls whether or not the width and height of the drawn geometry are kept equal. Applies to rectangle and circle.
defaultUpdateOptions Object
Since: ArcGIS Maps SDK for JavaScript 4.11 Sketch since 4.10, defaultUpdateOptions added at 4.11.
Default update options set for the Sketch widget. Update options set on this property will be overwritten if the update options are changed when update() method is called.
Name of the update tool. The default tool is transform for graphics with polygon and polyline geometries and move for graphics with point and multipoint geometries. However, if a graphic with point geometry uses a 3D object symbol layer, the default tool is transform.
Possible Values:"move"|"transform"|"reshape"
enableRotation Boolean optionalDefault Value:true
Indicates if the rotation operation will be enabled when updating graphics. Only applies if tool is transform.
Default Value:true
Indicates if the scale operation will be enabled when updating graphics. Only applies if tool is transform.
Default Value:true
Indicates if z-values can be modified when updating the graphic. When enabled, the height handle manipulator is displayed.
multipleSelectionEnabled Boolean optionalDefault Value:true
Indicates whether more than one selection can be made at once. This applies to the shift+click interaction with the transform tool.
Default Value:false
Indicates if the uniform scale operation will be enabled when updating graphics. enableScaling must be set true when setting this property to true. Only applies if tool is transform and is always true when transforming points that use a 3D object symbol layer.
Default Value:true
Indicates if the graphic being updated can be toggled between transform and reshape update options.
Changes the behavior for the reshape tool. Defines the operations for edge and/or the constraints for moving a shape and/or a vertex. Only supported in 3D.
Default Value:"split"
Sets the reshape operation on the edge. This affects lines and polygons. Fully supported in 3D, partially in 2D.
Value Description none No manipulators show up on the edge. (2D and 3D) split Manipulators show up to split edges by adding a new vertex. (2D and 3D) offset Manipulators show up to offset the edges. (only 3D)Possible Values:"none"|"split"|"offset"
shapeOperation String optionalDefault Value:"move"
Sets the move constraints for the whole shape. Supported in 2D and 3D
Value Description none No move manipulator show up. (2D and 3D) move Move manipulator show up to move in xy and in z. (2D and 3D) move-xy Move manipulator show up to move in xy only. (only 3D)Possible Values:"none"|"move"|"move-xy"
vertexOperation String optionalDefault Value:"move"
Sets the move constraints for the vertex. Only supported in 3D.
Value Description move Move manipulator show up to move in xy and in z. move-xy Move manipulator show up to move in xy only.Possible Values:"move"|"move-xy"
Options that control when to display or hide highlights for update operations.
Default Value:true
Indicates if highlighting is enabled for update operations. Only supported in 2D.
Example
// Turn off highlights for update operations
const sketch = new Sketch({
view,
defaultUpdateOptions: {
highlightOptions: {
enabled: false
}
}
});
// Turn off highlights from the update() method
const updateOptions = { tool: "reshape", highlightOptions: { enabled: false }};
sketch.update(graphic, updateOptions);Since: ArcGIS Maps SDK for JavaScript 4.27 Sketch since 4.10, icon added at 4.27.
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
Inherited
Property id String
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
The Sketch widget's default label.
Since: ArcGIS Maps SDK for JavaScript 4.24 Sketch since 4.10, labelOptions added at 4.24.
Options to configure the sketch labels shown next to each segment of the geometry being created or updated.
Known Limitation
Sketch labels are currently only supported when working with a SceneView.
The GraphicsLayer associated with the Sketch widget. The Sketch widget adds new graphics to this layer or can only update graphics stored in this layer.
Determines the layout/orientation of the Sketch widget.
Possible Values:"vertical" |"horizontal"
Default Value:"horizontal"
Since: ArcGIS Maps SDK for JavaScript 4.32 Sketch since 4.10, scale added at 4.32.
Determines the size of widget elements.
Possible Values:"s" |"m" |"l"
state Stringreadonly
The Sketch widget's state.
Possible Values:"ready" |"disabled" |"active"
toolbarKind String
Since: ArcGIS Maps SDK for JavaScript 4.32 Sketch since 4.10, toolbarKind added at 4.32.
Controls the appearance of the sketch widget, allowing the toolbar to adapt its appearance appropriately based on context. Use 'docked' when the Sketch widget is embedded in another UI component like a panel; in this view, the widget stretches to fill available space.
"floating" appearance is optimized for situations where the Sketch widget is "floating" on top of the map. This appearance has a drop shadow, rounded corners, and dynamic layout that works well on a map or scene.
Subject to change, Sketch uses Calcite Action Pad in "floating" mode, and Calcite Action Bar in docked mode.
In both modes, Sketch will expand to fill available width, then collapse overflowing items into split-button or overflow menu groups as appropriate. In docked mode, Sketch expands to the width (in horizontal layout) or height (in vertical layout) of the nearest ancestor.
Possible Values:"docked" |"floating"
Since: ArcGIS Maps SDK for JavaScript 4.24 Sketch since 4.10, tooltipOptions added at 4.24.
Options to configure the tooltip shown next to the cursor when creating or updating graphics.
An array of graphics that are being updated by the Sketch widget.
Since: ArcGIS Maps SDK for JavaScript 4.29 Sketch since 4.10, valueOptions added at 4.29.
Options to configure how values are displayed and input when creating or updating graphics.
The view model for the Sketch widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the SketchViewModel class to access all properties and methods on the Sketch widget.
Inherited
Property visible Boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".
Example
// Hides the widget in the view
widget.visible = false;The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
The image below displays the default Sketch widget with selection, undo/redo, and settings menu tools.
In comparison, this image shows how the widget displays with some of its tools not visible as set in the example code snippet below.
Example
// Setting the sketch's visible elements as below would result
// in removing the point and circle tools. It also removes the
// lasso-selection tool and settings menu.
sketch.visibleElements = {
createTools: {
point: false,
circle: false
},
selectionTools:{
"lasso-selection": false
},
settingsMenu: false
}Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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.
Cancels the active operation and fires the create or update event. If called in the middle of a create operation, cancel() discards the partially created graphic.
Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
Returns
Type Description String The computed class name.Example
// .tsx syntax showing how to set css classes while rendering the widget
render() {
const dynamicClasses = {
[css.flip]: this.flip,
[css.primary]: this.primary
};
return (
<div class={classes(css.root, css.mixin, dynamicClasses)} />
);
} complete()
Completes the active operation and fires the create or update event and changes the event's state to complete. If called in the middle of a create operation, complete() finishes the active create operation and keeps the valid geometry.
create(tool, createOptions){Promise<void>}
Create a graphic with the geometry specified in the tool parameter. When the first vertex of the graphic is added, the create event will start firing. The provided tool will become the activeTool.
Parameters
Specification
tool StringName of the create tool. Specifies the geometry for the graphic to be created.
Possible Values:"point"|"polyline"|"polygon"|"rectangle"|"circle"
createOptions Object optionalOptions for the graphic to be created.
Specification
defaultZ Number optionalThe default z-value of the newly created geometry. Ignored when hasZ is false or the layer's elevation mode is set to absolute-height.
Controls whether the created geometry has z-values or not.
mode String optionalSpecifies how the graphic can be created. The create mode applies only when creating polygon, polyline, rectangle and circle geometries.
polygon and polyline. freehand Vertices are added while the pointer is dragged. Applies to polygon, polyline rectangle and circle. Default for rectangle and circle. click Vertices are added when the pointer is clicked. Applies to polygon, polyline rectangle and circle. Default for polygon and polyline.
Possible Values:"hybrid"|"freehand"|"click"
preserveAspectRatio Boolean optionalControls whether or not the width and height of the drawn geometry are kept equal. Applies to rectangle and circle.
Returns
Type Description Promise<void> Resolves when the requested update tool has been loaded and is ready to use.Example
// Call create method to create a polygon with freehand mode.
sketch.create("polygon", { mode: "freehand" });
// listen to create event, only respond when event's state changes to complete
sketch.on("create", function(event) {
if (event.state === "complete") {
// remove the graphic from the layer associated with the Sketch widget
// instead use the polygon that user created to query features that
// intersect it.
polygonGraphicsLayer.remove(event.graphic);
selectFeatures(event.graphic.geometry);
}
});
// create a square
sketch.create("rectangle", { preserveAspectRatio: true });
// create an ellipse
sketch.create("circle", { preserveAspectRatio: false });Since: ArcGIS Maps SDK for JavaScript 4.14 Sketch since 4.10, delete added at 4.14.
Deletes the selected graphics used in the update workflow. Calling this method will fire the delete event.
Inherited
Method destroy()
Destroys the widget instance.
duplicate()
Since: ArcGIS Maps SDK for JavaScript 4.26 Sketch since 4.10, duplicate added at 4.26.
Duplicates current graphics used in the update workflow and automatically adds them to the associated layer
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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
Method isFulfilled(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() method that should be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
// event is the event handle returned after the event fires.
console.log(event.mapPoint);
});Inherited
Method postInitialize()
Executes after widget is ready for rendering.
Incrementally redo actions recorded in the stack. Calling this method will fire the redo event. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
Incrementally undo actions recorded in the stack. Calling this method will fire the undo event. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
update(graphics, updateOptions){Promise<void>}
Initializes an update operation for the specified graphic(s) and fires update event.
Parameters
Specification
graphics Graphic|Graphic[]A graphic or an array of graphics to be updated. Only graphics added to SketchViewModel's layer property can be updated.
updateOptions Object optionalUpdate options for the graphics to be updated.
Specification
tool String optionalName of the update tool. Specifies the update operation for the selected graphics. The provided tool will become the activeTool.
Possible Values
Value Description transform This is the default tool for graphics with a polygon geometry, polyline geometry or graphics that use a 3D object symbol layer with a point geometry. It allows one or multiple graphics to be scaled, rotated and moved by default. Its default behavior can be changed by setting theenableRotation, enableScaling or preserveAspectRatio arguments when calling the update method or setting them on the defaultUpdateOptions property when the Sketch widget initializes. reshape This tool allows the entire graphic or individual vertices of the graphic to be moved. Vertices can be added or removed. This tool can only be used with a single graphic that has a polygon or polyline geometry. move This is the default tool for graphics with a point geometry that do not use a 3D object symbol layer. It should be used for specific cases where you just want to move selected polygon and polyline graphics without additional options. Additionally, the move tool does not support toggling to different modes, since the move operation is built into both the transform and reshape tools by default.
Possible Values:"transform"|"reshape"|"move"
enableRotation Boolean optionalDefault Value: true
Indicates if the rotation operation will be enabled when updating graphics. Only applies if tool is transform.
Default Value: true
Indicates if the scale operation will be enabled when updating graphics. Only applies if tool is transform.
Default Value: true
Indicates if z-values can be modified when updating the graphic. When enabled, the height handle manipulator is displayed.
multipleSelectionEnabled Boolean optionalDefault Value: true
Indicates whether more than one selection can be made at once. This applies to the shift+click interaction with the transform tool.
Default Value: false
Indicates if the uniform scale operation will be enabled when updating graphics. enableScaling must be set true when setting this property to true. Only applies if tool is transform and is always true when transforming points that use a 3D object symbol layer.
Default Value: true
Indicates if the graphic being updated can be toggled between transform and reshape update options.
Returns
Type Description Promise<void> Resolves when the requested update tool has been loaded and is ready to use.Examples
// start update operation for the selected graphic
// with transform tool. Only allow uniform scaling operation.
sketch.update([selectedGraphic], {
tool: "transform",
enableRotation: false,
enableScaling: true,
preserveAspectRatio: true,
toggleToolOnClick: false
});// Listen to sketch's update event to validate graphic's
// location while it is being reshaped or moved
sketch.on("update", onGraphicUpdate);
function onGraphicUpdate(event) {
// get the graphic as it is being updated
const graphic = event.graphics[0];
// check if the graphic is intersecting school buffers
intersects = geometryEngine.intersects(buffers, graphic.geometry);
// change the graphic symbol to valid or invalid symbol
// depending the graphic location
graphic.symbol = (intersects) ? invalidSymbol : validSymbol
// check if the update event's the toolEventInfo.type is move-stop or reshape-stop
// user finished moving or reshaping the graphic, call complete method.
// This changes update event state to complete.
const toolType = event.toolEventInfo.type;
if (event.toolEventInfo && (toolType === "move-stop" || toolType === "reshape-stop")) {
if (!intersects) {
sketch.complete();
}
} else if (event.state === "complete") {
// graphic update has been completed
// if the graphic is in a bad spot, call sketch's update method again
// giving user a chance to correct the location of the graphic
if ((!contains) || (intersects)) {
sketch.update([graphic], {
tool: "reshape",
toggleToolOnClick: false
});
}
}
}Inherited
Method when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
Example
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
// This function will execute once the promise is resolved
}, function(error){
// This function will execute if the promise is rejected due to an error
});This information is returned as toolEventInfo parameter for the create event when the graphic is being created. It returns VertexAddEventInfo when the user clicks the view or CursorUpdateEventInfo or when the user moves the cursor.
CursorUpdateEventInfo Object
This information is returned as toolEventInfo parameter for the create event when the user moves the cursor on the view while the graphic is being created.
The value is always "cursor-update".
An array of numbers representing the coordinates of the cursor location.
Example
// listen to create event
sketch.on("create", function(event){
// respond to create event while the cursor is being moved on the view.
const eventInfo = event.toolEventInfo;
if (eventInfo && eventInfo.type === "cursor-update"){
console.log(eventInfo.type, eventInfo.coordinates[0], eventInfo.coordinates[1]);
}
}); MoveEventInfo Object
This information is returned as toolEventInfo parameter for the update event while the user is moving the graphics. It returns additional information associated with the move operation and what stage it is at.
Returns information indicating the stage of the move operation.
Possible Values
Value Description move-start The type changes tomove-start at the start of move operation. move The type changes to move while graphics are being moved. move-stop The type changes to move-stop once graphics are moved.
Possible Values:"move-start"|"move"|"move-stop"
dx NumberNumber of pixels moved on the x-axis from the last known position.
dy NumberNumber of pixels moved on the y-axis from the last known position.
mover GraphicThe instance of the graphic that is being moved.
Example
// listen to update event
sketch.on("update", function(event){
// check if the graphics are done being moved, printout dx, dy parameters to the console.
const eventInfo = event.toolEventInfo;
if (eventInfo && eventInfo.type.includes("move")){
console.log(eventInfo.type, eventInfo.dx, eventInfo.dy);
}
}); ReshapeEventInfo Object
This information is returned as toolEventInfo parameter for the update event while the user is reshaping the graphics. It returns additional information associated with the reshape operation and what stage it is at.
Returns information indicating the stage of the reshape operation.
Possible Values
Value Description reshape-start The type changes toreshape-start at the start of reshape operation. reshape The type changes to reshape while graphics are being reshaped. reshape-stop The type changes to reshape-stop once graphics are reshaped.
Possible Values:"reshape-start"|"reshape"|"reshape-stop"
Example
// listen to update event
sketch.on("update", function(event){
// check if the graphics are done being reshaped, printout updated graphic's geometry and reshape stage.
const eventInfo = event.toolEventInfo;
if (eventInfo && eventInfo.type.includes("reshape")) {
console.log(eventInfo.type, event.graphics[0].geometry);
}
}); RotateEventInfo Object
This information is returned as toolEventInfo parameter for the update event while the user is rotating the graphics. It returns additional information associated with the rotate operation and what stage it is at.
Returns information indicating the stage of the rotate operation.
Possible Values
Value Description rotate-start The type changes torotate-start at the start of rotate operation. rotate The type changes to rotate while graphics are being rotated. rotate-stop The type changes to rotate-stop once graphics are rotated.
Possible Values:"rotate-start"|"rotate"|"rotate-stop"
angle NumberAngle of rotation in degrees.
Example
// listen to update event
sketch.on("update", function(event){
if (event.tool === "transform") {
if (event.toolEventInfo) {
const info = event.toolEventInfo,
type = info.type;
// rotate events only
if (type.includes("rotate")) {
// check if the rotation angle exceeded 45
if (info.angle > 45) {
// complete the graphic update operation
sketch.complete();
}
}
}
}
}); ScaleEventInfo Object
This information is returned as toolEventInfo parameter for the update event while the user is scaling or resizing the graphics. It returns additional information associated with the scale operation and what stage it is at.
Returns information indicating the stage of the scale operation.
Possible Values
Value Description scale-start The type changes toscale-start at the start of scale or resize operation. scale The type changes to scale while graphics are being scaled or resized. scale-stop The type changes to scale-stop once graphics are scaled or resized.
Possible Values:"scale-start"|"scale"|"scale-stop"
xScale NumberThe x scale factor used to enlarge or shrink the geometry.
yScale NumberThe y scale factor used to enlarge or shrink the geometry.
SelectionChangeEventInfo Object
This information is returned as toolEventInfo parameter for the update event while the user is selecting or deselecting graphics using Shift+Left-click.
The value is always "selection-change".
An array of graphics representing the latest graphic selected.
An array of graphics representing the latest graphic deselected.
Example
// listen to update event
sketch.on("update", function(event) {
const eventInfo = event.toolEventInfo;
// check if a graphic is being selected or deselected.
if (eventInfo && eventInfo.type === "selection-change") {
if(eventInfo.added.length > 0) {
// graphic is being added to the currently selected graphics.
console.log("geometry type added: ", eventInfo.added[0].geometry.type);
} else {
// graphic is being removed from the currently selected graphics.
console.log("geometry type removed: ", eventInfo.removed[0].geometry.type);
}
}
});This information is returned as toolEventInfo parameter for the update event when the user is updating graphics.
VertexAddEventInfo Object
This information is returned as toolEventInfo parameter for the create or update event when the user adds vertices to the graphic being created or updated.
The value is always "vertex-add".
An array of x,y coordinates representing the vertices added.
Contains the details of the added vertices to track changes in topology of the geometry.
An array of x,y coordinates representing the vertices added.
The ring/path index of the added vertex.
The index of the vertex position.
Example
// listen to create event
sketch.on("create", function(event){
// check if vertices are being added to the graphic that is being updated.
if (event.toolEventInfo && event.toolEventInfo.type === "vertex-add"){
const addedPoint = event.toolEventInfo.added[0].geometry;
console.log(event.toolEventInfo.type, addedPoint.x, addedPoint.y);
}
}); VertexRemoveEventInfo Object
This information is returned as toolEventInfo parameter for the update event when the user is removing vertices from the graphic.
The value is always "vertex-remove".
An array of x,y coordinates representing the vertices removed.
Contains the details of the removed vertices to track changes in topology of the geometry.
An array of x,y coordinates representing the vertices removed.
The ring/path index of the removed vertex.
The index of the vertex position.
Example
// listen to update event
sketch.on("update", function(event){
// check if vertices are being added to the graphic that is being updated.
const eventInfo = event.toolEventInfo;
if (eventInfo && eventInfo.type === "vertex-remove"){
const removedPoint = eventInfo.removed[0].geometry;
console.log(eventInfo.type, removedPoint.x,removedPoint.y);
}
});The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
The available sketch tools within the widget.
Indicates whether to display the point sketch tool. Default is true.
Indicates whether to display the polyline sketch tool. Default is true.
Indicates whether to display the polygon sketch tool. Default is true.
Indicates whether to display the rectangle sketch tool. Default is true.
Indicates whether to display the circle sketch tool. Default is true.
{REPLACE-AT}since 4.32 Indicates whether to display the freehandPolyline tool. Default is false.
{REPLACE-AT}since 4.32 Indicates whether to display the freehandPolygon tool. Default is false.
Indicates whether to display the 'duplicate' button while a graphic is selected. Default is true.
Indicates whether to display the 'delete' button while a graphic is selected. Default is true. Do not hide this button without giving users on touch devices another way to delete selected geometries.
Indicates whether to display a label indicating the length of the currently selected feature set.
The available selection tools within the widget.
Known Limitation
Rectangle and lasso selection is only supported when working with a MapView.
Indicates whether to display the "rectangle-selection" tool. Default is true.
Indicates whether to display the "lasso-selection" tool. Default is true.
Indicates whether to display the settings menu. Currently this menu contains snapping options. Default value is true.
Since 4.29. Indicates whether to display the sketch labels toggle. Default value is true.
Since 4.29. Indicates whether to display the tooltips toggle. Default value is true.
Indicates whether to display the SnappingControls widget. Default is true.
The available SnappingControls elements within the widget.
Indicates whether to display the header. Default is false.
Indicates whether to display the enabledToggle (Enable snapping). Default is true. This toggles the SnappingOptions.enabled property.
Note
It is recommended to set Sketch.snappingOptions.enabled = true if enabledToggle is set to false. This is because selfEnabledToggle and featureEnabledToggle require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.
Indicates whether to display the selfEnabledToggle (Geometry guides). Default is true. This toggles the SnappingOptions.selfEnabled property.
Indicates whether to display the featureEnabledToggle (Feature to feature). Default is true. This toggles the SnappingOptions.featureEnabled property.
Indicates whether to display the FeatureSnappingLayerSource layerList. Default is true. The layerlist provides the available layer sources supported for snapping.
Indicates whether to display the âEnable allâ or âDisable allâ button to enable / disable snapping for all the layers in the list.
Since 4.30. Indicates whether to display the grid display toggle embedded in grid controls. Default is false.
Since 4.30. Indicates whether to display the grid controls widget embedded in snapping controls. Default is true.
Since 4.30. The available GridControls elements within the widget.
Indicates whether to display the grid snapping toggle embedded in grid controls. Default is false.
Indicates whether to display the grid display toggle embedded in grid controls. Default is false.
Indicates whether to display the color/theme selection component of grid controls. Default is true.
Indicates whether to display the dynamic scaling toggle in grid controls. Default is true.
Indicates whether to display the 'rotate with map' toggle in grid controls. Default is true.
Indicates whether to display the spacing and rotation inputs in grid controls. Default is true.
Indicates whether to display the major line interval input in grid controls. Default is true.
Indicates whether to display the interactive placement buttons in grid controls. Default is true.
Indicates whether to display a notice when the grid is not visible because it is out of scale and dynamic scaling is turned off. Default is true.
Indicates whether to display the undo/redo menu within the widget. Default is true.
Examples
// This hides the lasso selection tools
sketch.visibleElements = {
selectionTools: {
"lasso-selection": false
}
}// This removes the feature enabled snapping toggle and the layerlist.
sketch.visibleElements = {
snappingControlsElements: {
featureEnabledToggle: false,
layerList: false
}
}// This hides the undo/redo tools
sketch.visibleElements = {
undoRedoMenu: false
}Fires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic.
Sketch delete {graphics: Graphic[],tool: "move"|"reshape"|"transform",type: "delete"}Fires when a user deletes selected graphics by clicking the Delete feature button on the Sketch widget or when delete() method is called.
Fires in response to redo action during creation of a new graphic or updating existing graphics.
Sketch undo {graphics: Graphic[],tool: "point"|"polyline"|"polygon"|"rectangle"|"circle"|"move"|"transform"|"reshape",type: "undo"}Fires in response to undo action during creation of a new graphic or updating existing graphics.
Sketch update {graphics: Graphic[],state: "start"|"active"|"complete",aborted: Boolean,tool: "move"|"transform"|"reshape",type: "update",toolEventInfo: UpdateToolEventInfo}Fires when the user starts updating graphics, is actively updating graphics, and completes updating graphics.
Sketch Event DetailsFires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic.
The graphic that is being created.
state StringThe current state of the event.
Possible Values
Value Description start State changes tostart when the first vertex is created. Not applicable when creating points. active State is active while graphic is being created. Not applicable when creating points. complete State changes to complete after the complete() method is called, when the user double clicks, presses the Enter key or clicks the first vertex of the polygon while creating a graphic. When point is created, the create event is fired with the complete state. cancel State changes to cancel if the user pressed the escape key or create() or cancel() methods are called during the create operation and before the state changes to complete.
Possible Values:"start"|"active"|"complete"|"cancel"
tool StringName of the create tool.
Possible Values:"point"|"polyline"|"polygon"|"rectangle"|"circle"
toolEventInfo CreateToolEventInfoReturns additional information associated with the create operation such as where the user is clicking the view or where the user is moving the cursor to. Value of this parameter changes to null when the create event's state changes to complete or cancel.
The value is always "create".
Example
// Listen to sketch widget's create event.
sketch.on("create", function(event) {
// check if the create event's state has changed to complete indicating
// the graphic create operation is completed.
if (event.state === "complete") {
// remove the graphic from the layer. Sketch adds
// the completed graphic to the layer by default.
polygonGraphicsLayer.remove(event.graphic);
// use the graphic.geometry to query features that intersect it
selectFeatures(event.graphic.geometry);
}
});Since: ArcGIS Maps SDK for JavaScript 4.14 Sketch since 4.10, delete added at 4.14.
Fires when a user deletes selected graphics by clicking the Delete feature button on the Sketch widget or when delete() method is called.
An array of deleted graphics.
Name of the tool that was active when graphics are deleted.
Possible Values:"move"|"reshape"|"transform"
The value is always "delete".
Example
// selected graphics can be deleted only when update event becomes active
sketch.on("update", function(event) {
if (event.state === "active") {
sketch.delete();
}
});
// fires after delete method is called
// returns references to deleted graphics.
sketch.on("delete", function(event) {
event.graphics.forEach(function(graphic){
console.log("deleted", graphic)
});
});Fires in response to redo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
An array of graphics that are being updated or created.
Name of the create or update tool that is active.
Possible Values:"point"|"polyline"|"polygon"|"rectangle"|"circle"|"move"|"transform"|"reshape"
The value is always "redo".
Fires in response to undo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can redo/undo actions while creating or updating a graphic.
An array of graphics that are being updated or created.
Name of the create or update tool that is active.
Possible Values:"point"|"polyline"|"polygon"|"rectangle"|"circle"|"move"|"transform"|"reshape"
The value is always "undo".
Fires when the user starts updating graphics, is actively updating graphics, and completes updating graphics.
An array of graphics that are being updated.
state StringThe state of the event.
Possible Values
Value Description start State changes tostart when a graphic is selected to be updated. active State is active while graphics are being updated and toolEventInfo parameter is not null. complete State changes to complete after graphics are updated.
Possible Values:"start"|"active"|"complete"
aborted BooleanIndicates if the update operation was aborted. Set to true if the user pressed the escape key, or when the update(), create() or cancel() method is called before the update event's state changes to complete.
Name of the update operation tool.
Possible Values:"move"|"transform"|"reshape"
type StringThe value is always "update".
toolEventInfo UpdateToolEventInfoReturns additional information associated with the update operation that is taking place for the selected graphics and what stage it is at. Value of this parameter changes to null when the update event's state changes to complete.
Example
// Listen to sketch's update event to show relevant data in a chart
// as the graphics are being moved
sketch.on("update", onMove);
// Point graphics at the center and edge of the buffer polygon are being moved.
// Recalculate the buffer with updated geometry and run the query stats using
// the updated buffer and update the chart.
function onMove(event) {
// If the edge graphic is moving, keep the center graphic
// at its initial location. Only move edge graphic to resize the buffer.
if (event.toolEventInfo && event.toolEventInfo.mover.attributes.edge) {
const toolType = event.toolEventInfo.type;
if (toolType === "move-start") {
centerGeometryAtStart = centerGraphic.geometry;
}
// keep the center graphic at its initial location when edge point is moving
else if (toolType === "move" || toolType === "move-stop") {
centerGraphic.geometry = centerGeometryAtStart;
}
}
// the center or edge graphic is being moved, recalculate the buffer
const vertices = [
[centerGraphic.geometry.x, centerGraphic.geometry.y],
[edgeGraphic.geometry.x, edgeGraphic.geometry.y]
];
// client-side stats query of features that intersect the buffer
calculateBuffer(vertices);
// user is clicking on the view... call update method with the center and edge graphics
if (event.state === "complete") {
sketch.update([edgeGraphic, centerGraphic], { tool: "move" });
}
}RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4