SketchViewModel

require(["esri/widgets/Sketch/SketchViewModel"], function(SketchViewModel) { /* code goes here */ });
Class: esri/widgets/Sketch/SketchViewModel
Inheritance: SketchViewModel Accessor
Since: ArcGIS API for JavaScript 4.5

SketchViewModel simplifies the process of adding and updating graphics on the MapView. SketchViewModel is intended to be used with Graphics. Its events allow control of a graphic's geometry. Use the DrawAction class if more fine-grained control is needed with vertices when creating graphics.

SketchViewModel provides the logic for Sketch widget, which will be added in a future release. The Sketch widget will simplify the process of adding graphics to the view with minimal code.

Pointer and keyboard gestures for creating graphics with different geometries are described in the tables below.

Creating point graphics

GestureAction
Left-clickAdds a point graphic at the pointer location.
CAdds a point graphic at the pointer location.

Creating multipoint graphics

GestureAction
Left-clickAdds a point at the pointer location.
FAdds a point to the multipoint graphic.
CCompletes the multipoint graphic sketch.
ZIncrementally undo actions recorded in the stack.
RIncrementally redo actions recorded in the stack.

Creating polyline and polygon graphics

GestureAction
Left-clickAdds a vertex at the pointer location.
Left-dragAdds a vertex for each pointer move.
FAdds a vertex to the polyline or polygon graphic.
CCompletes the polyline or polygon graphic sketch.
ZIncrementally undo actions recorded in the stack.
RIncrementally redo actions recorded in the stack.
Ctrl+Left-click or dragForces new vertices to be parallel or perpendicular to the previous vertex
Left-click on the first vertexCompletes the polygon graphic sketch.

Creating graphics with predefined shapes

The following keyboard shortcuts apply when creating graphics with predefined shapes.

GestureAction
Left-click+DragDraws rectangle or circle graphic.
Ctrl+Left-click+DragChanges the shape of the sketch: Rectangle to square or circle to ellipse.
Alt+Left-click+DragCreates a sketch with a center based on initial click, with dimensions calculated based on distance from cursor to center.
Ctrl+Alt+Left-click+DragChanges the shape of the sketch and center to be the initial click location with dimensions based on distance from cursor to center.

Updating graphics

SketchViewModel can update existing graphics by moving, rotating, or scaling the whole geometry of the graphic, or moving one or more vertices. To update a graphic, left-click on the graphic and the following actions can be performed.

GestureActionExample
Left-click a graphicSelect a graphic to move, rotate or scale.Select a Graphic
Drag the graphicMove the graphic.Drag a Geometry
Drag the graphic by rotate handleRotate the graphic.Rotate a Graphic
Drag the graphic by scale handleScale the graphic.Scale a graphic
Left-click the graphicSelect the graphic to move or reshape.Select a Graphic
Drag the graphicMove the graphic.Drag a Graphic
Left-click on a vertexSelect a vertex.Select a Vertex
Shift+Left-click on verticesSelect or unselect multiple vertices.Select Vertices
Drag a selected vertexMove a vertex or vertices.Drag vertices
Left-click on view (not the graphic)Complete the graphic update. If graphic is updated, update-complete event will be fired. If not, update-cancel will be fired.Sketch Update Complete
See also:
Example:
// Create a new sketch view model and
// assign symbols for each geometry type
var sketch = new SketchViewModel({
  view: view,
  layer: tempGraphicsLayer,
  pointSymbol: {
    type: "simple-marker",  // autocasts as new SimpleMarkerSymbol()
    style: "square",
    color: "red",
    size: "16px",
    outline: {  // autocasts as new SimpleLineSymbol()
      color: [255, 255, 0],
      width: 3
    }
  },
  polylineSymbol: {
    type: "simple-line",  // autocasts as new SimpleMarkerSymbol()
    color: "#8A2BE2",
    width: "4",
    style: "dash"
  },
  polygonSymbol: {
    type: "simple-fill",  // autocasts as new SimpleMarkerSymbol()
    color: "rgba(138,43,226, 0.8)",
    style: "solid",
    outline: { // autocasts as new SimpleLineSymbol()
      color: "white",
      width: 1
    }
  }
});

Constructors

new SketchViewModel(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var sketch = new SketchViewModel({
  view: view,
  layer: graphicsLayer
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Graphic

Graphic representing the sketch that is being drawn on the view.

more details
more detailsSketchViewModel
GraphicsLayer

GraphicsLayer associated with the SketchViewModel.

more details
more detailsSketchViewModel
SimpleMarkerSymbol

A simple marker symbol used for representing the point geometry that is being drawn.

more details
more detailsSketchViewModel
SimpleFillSymbol

A simple fill symbol used for representing the polygon geometry that is being drawn.

more details
more detailsSketchViewModel
SimpleLineSymbol

A simple line symbol used for representing the polyline geometry that is being drawn.

more details
more detailsSketchViewModel
String

The sketch view model's state.

more details
more detailsSketchViewModel
MapView

The view in which geometries will be sketched by the user.

more details
more detailsSketchViewModel

Property Details

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

graphicGraphicreadonly

Graphic representing the sketch that is being drawn on the view.

Since: ArcGIS API for JavaScript 4.6

GraphicsLayer associated with the SketchViewModel. It allows you to organize where temporary graphics are placed when the drawing is completed.

Example:
sketchViewModel.on("create-complete", function (event) {
  // Create a new graphic and set its geometry to
  // `create-complete` event geometry.
  const graphic = new Graphic({
    geometry: event.geometry,
    symbol: sketchViewModel.graphic.symbol
  });
  tempGraphicsLayer.add(graphic);
});

A simple marker symbol used for representing the point geometry that is being drawn.

The default value is the following:

{
  type: "simple-marker",
  style: "circle",
  size: 6,
  color: [255, 255, 255],
  outline: {
   color: [50, 50, 50],
    width: 1
  }
}
polygonSymbolSimpleFillSymbol

A simple fill symbol used for representing the polygon geometry that is being drawn.

The default value is the following:

{
  type: "simple-fill",
  color: [150, 150, 150, 0.2],
  outline: {
   color: [50, 50, 50],
    width: 2
  }
}
polylineSymbolSimpleLineSymbol

A simple line symbol used for representing the polyline geometry that is being drawn.

The default value is the following:

{
  type: "simple-line",
  color: [130, 130, 130],
  width: 2
}
stateStringreadonly

The sketch view model's state.

Possible Values: ready | disabled | creating | updating

The view in which geometries will be sketched by the user.

Method Overview

NameReturn TypeSummaryClass

Completes the active drawing and fires the create-complete event.

more details
more detailsSketchViewModel

Creates the requested draw action.

more details
more detailsSketchViewModel

Emits an event on the instance.

more details
more detailsSketchViewModel
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsSketchViewModel
Object

Registers an event handler on the instance.

more details
more detailsSketchViewModel

Resets SketchViewModel to prepare for another create operation.

more details
more detailsSketchViewModel

Initializes an update operation for the selected geometry and fires update-init event.

more details
more detailsSketchViewModel

Method Details

complete()
Since: ArcGIS API for JavaScript 4.6

Completes the active drawing and fires the create-complete event. If called mid-drawing, complete() finishes the active drawing and keeps the valid geometry.

create(drawAction, drawOptions)

Creates the requested draw action.

Note: Creating a circle geometry does not work in all spatial references.

Parameters:
drawAction String

Name of the draw action tool.

Possible Values: point | multipoint | polyline | polygon | rectangle | circle

drawOptions Object
optional

Object of the drawing options for the geometry to be created.

Specification:
mode String
optional

The drawing mode. The drawing mode applies only when creating polygon, polyline, rectangle and circle geometries.

Possible Values:

ValueDescription
hybridVertices are added while the pointer is clicked or dragged. Applies to and is the default for polygon and polyline.
freehandVertices are added while the pointer is dragged. Applies to polygon, polyline rectangle and circle. Default for rectangle and circle.
clickVertices are added when the pointer is clicked.
Example:
// create a new instance of sketch view model
// and associate it with a map view.
var sketch = new SketchViewModel({
  view: view
});

// set up the SketchViewModel to create polygon geometries
sketch.create("polygon", {mode: "freehand"});
emit(type, event)

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object

The event payload.

hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
reset()

Resets SketchViewModel to prepare for another create operation. Reset discards the current drawing, if called mid drawing.

update(graphic)
Since: ArcGIS API for JavaScript 4.7

Initializes an update operation for the selected geometry and fires update-init event.

Parameter:
graphic Graphic

The graphic to be updated.

Event Overview

NameTypeSummaryClass
{geometry: Geometry,target: Object,tool: String,type: String}

Fires during geometry create operation.

more details
more detailsSketchViewModel
{target: Object,tool: String,type: String}

Fires if create() or reset() method is called after create-start event is fired and before create-complete event is fired.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,tool: String,type: String}

Fires after complete() method is called.

more details
more detailsSketchViewModel
{target: Object,tool: String,type: String}

Fires after create() method is called.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,tool: String,type: String}

Fires after the first vertex is created.

more details
more detailsSketchViewModel
{dx: Number,dy: Number,geometry: Geometry,target: Object,type: String}

Fires during graphic move operation.

more details
more detailsSketchViewModel
{dx: Number,dy: Number,geometry: Geometry,target: Object,type: String}

Fires when graphic move operation is completed.

more details
more detailsSketchViewModel
{dx: Number,dy: Number,geometry: Geometry,target: Object,type: String}

Fires at the start of graphic move operation.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires during graphic reshape operation.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires when graphic reshape operation is completed.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires at the start of reshape operation.

more details
more detailsSketchViewModel
{angle: Number,geometry: Geometry,target: Object,type: String}

Fires during graphic rotation operation.

more details
more detailsSketchViewModel
{angle: Number,geometry: Geometry,target: Object,type: String}

Fires once graphic rotation operation is completed.

more details
more detailsSketchViewModel
{angle: Number,geometry: Geometry,target: Object,type: String}

Fires at the start of graphic rotation operation.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String,xScale: Number,yScale: Number}

Fires during graphic scale or resize operation.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String,xScale: Number,yScale: Number}

Fires when graphic scale operation is completed.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String,xScale: Number,yScale: Number}

Fires at the start of scale operation.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires when graphic is selected and then unselected without any updates, or when create() or reset() is called before update-complete event is fired.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires after graphic is updated.

more details
more detailsSketchViewModel
{geometry: Geometry,target: Object,type: String}

Fires after user clicks on a graphic to update or when update() method is called.

more details
more detailsSketchViewModel

Event Details

create
Since: ArcGIS API for JavaScript 4.8

Fires during geometry create operation.

Properties:
geometry Geometry

The geometry that is being created.

target Object

A reference to the sketch view model object that dispatched the event.

tool String

The action tool selected in the create() method.

Possible Values: point | polyline | polygon | rectangle | circle

type String

The type of the event. For this event, the type is always create.

create-cancel
Since: ArcGIS API for JavaScript 4.8

Fires if create() or reset() method is called after create-start event is fired and before create-complete event is fired.

Properties:
target Object

A reference to the sketch view model object that dispatched the event.

tool String

The action tool selected in the create() method.

Possible Values: point | polyline | polygon | rectangle | circle

type String

The type of the event. For this event, the type is always create-cancel.

create-complete
Since: ArcGIS API for JavaScript 4.8

Fires after complete() method is called. The sketch can be completed when user double clicks, presses the C key or click the first vertex of the polygon while sketching.

Properties:
geometry Geometry

The geometry completed by the sketch view model.

target Object

A reference to the sketch view model object that dispatched the event.

tool String

The action tool selected in the create() method.

Possible Values: point | polyline | polygon | rectangle | circle

type String

The type of the event. For this event, the type is always create-complete.

Example:
sketch.on("create-complete", function (event) {
  // create a graphic with the completed geometry and add it to graphicslayer.
  var graphic = new Graphic({
    geometry: event.geometry,
    symbol: symbol
  });
  temGraphicsLayer.add(graphic);
});
create-init
Since: ArcGIS API for JavaScript 4.8

Fires after create() method is called.

Properties:
target Object

A reference to the sketch view model object that dispatched the event.

tool String

The action tool selected in the create() method.

Possible Values: point | polyline | polygon | rectangle | circle

type String

The type of the event. For this event, the type is always create-init.

create-start
Since: ArcGIS API for JavaScript 4.8

Fires after the first vertex is created.

Properties:
geometry Geometry

The geometry that is being created.

target Object

A reference to the sketch view model object that dispatched the event.

tool String

The action tool selected in the create() method.

Possible Values: point | polyline | polygon | rectangle | circle

type String

The type of the event. For this event, the type is always create-start.

move
Since: ArcGIS API for JavaScript 4.8

Fires during graphic move operation.

Properties:

Number of pixels moved on the x-axis from the last known position.

Number of pixels moved on the y-axis from the last known position.

geometry Geometry

The geometry that is being moved.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always move.

Example:
sketchViewModel.on("move", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
move-complete
Since: ArcGIS API for JavaScript 4.8

Fires when graphic move operation is completed.

Properties:

Number of pixels moved on the x-axis from the last known position.

Number of pixels moved on the y-axis from the last known position.

geometry Geometry

The geometry that has moved.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always move-complete.

Example:
sketchViewModel.on("move-complete", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
move-start
Since: ArcGIS API for JavaScript 4.8

Fires at the start of graphic move operation.

Properties:

Number of pixels moved on the x-axis from the last known position.

Number of pixels moved on the y-axis from the last known position.

geometry Geometry

The selected geometry for move operation.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always move-start.

Example:
sketchViewModel.on("move-start", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
reshape
Since: ArcGIS API for JavaScript 4.8

Fires during graphic reshape operation. With reshape operation, one or more vertices of the geometry can be moved.

Properties:
geometry Geometry

The geometry that is being reshaped.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always reshape.

Example:
sketchViewModel.on("reshape", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
reshape-complete
Since: ArcGIS API for JavaScript 4.8

Fires when graphic reshape operation is completed. With reshape operation, one or more vertices of the geometry can be moved.

Properties:
geometry Geometry

The geometry that has been reshaped.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always reshape-complete.

Example:
sketchViewModel.on("reshape-complete", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
reshape-start
Since: ArcGIS API for JavaScript 4.8

Fires at the start of reshape operation. With reshape operation, one or more vertices of the geometry can be moved.

Properties:
geometry Geometry

The geometry selected for reshape operation.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always reshape-start.

Example:
sketchViewModel.on("reshape-start", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // check the graphic geometry is intersecting school buffers
  // if so then the graphic update is invalid. Change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
rotate
Since: ArcGIS API for JavaScript 4.8

Fires during graphic rotation operation.

Properties:
angle Number

Angle of rotation in degrees.

geometry Geometry

The geometry that is being rotated.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always rotate.

Example:
sketchViewModel.on("rotate", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if the graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
rotate-complete
Since: ArcGIS API for JavaScript 4.8

Fires once graphic rotation operation is completed.

Properties:
angle Number

Angle of rotation in degrees.

geometry Geometry

The geometry that is rotated.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always rotate-complete.

Example:
sketchViewModel.on("rotate-complete", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if the graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
rotate-start
Since: ArcGIS API for JavaScript 4.8

Fires at the start of graphic rotation operation.

Properties:
angle Number

Angle of rotation in degrees.

geometry Geometry

The geometry to be rotated.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always rotate-start.

Example:
sketchViewModel.on("rotate-start", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if the graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
scale
Since: ArcGIS API for JavaScript 4.8

Fires during graphic scale or resize operation.

Properties:
geometry Geometry

The geometry that is being scaled or resized.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always scale.

xScale Number

The x scale factor used to enlarge or shrink the geometry.

yScale Number

The y scale factor used to enlarge or shrink the geometry.

Example:
sketchViewModel.on("scale", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if the graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
scale-complete
Since: ArcGIS API for JavaScript 4.8

Fires when graphic scale operation is completed.

Properties:
geometry Geometry

The geometry that has been scaled.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always scale-complete.

xScale Number

The x scale factor used to enlarge or shrink the geometry.

yScale Number

The y scale factor used to enlarge or shrink the geometry.

Example:
sketchViewModel.on("scale-complete", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
scale-start
Since: ArcGIS API for JavaScript 4.8

Fires at the start of scale operation.

Properties:
geometry Geometry

The selected geometry for scaling.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always scale-start.

xScale Number

The x scale factor used to enlarge or shrink the geometry.

yScale Number

The y scale factor used to enlarge or shrink the geometry.

Example:
sketchViewModel.on("scale-start", checkGraphicUpdate);

function checkGraphicUpdate(event) {
  // Update a graphic geometry to match the event geometry
  polyGraphic.geometry = event.geometry;

  // Check if the graphic geometry intersects school buffers.
  // If so, graphic update is invalid and change the symbol.
  intersects = geometryEngine.intersects(buffers, polyGraphic.geometry);
  polyGraphic.symbol = intersects ? invalidSymbol : validSymbol
}
update-cancel
Since: ArcGIS API for JavaScript 4.7

Fires when graphic is selected and then unselected without any updates, or when create() or reset() is called before update-complete event is fired.

Properties:
geometry Geometry

The geometry selected to be updated.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always update-cancel.

Example:
sketchViewModel.on("update-cancel", function(event){
  // Check if the updated geometry intersects buffer polygon
  if (intersects) {
    // Set the graphic symbol to an invalid symbol to let the user know
    // that the update is not allowed.
    newDevelopmentGraphic.symbol = invalidSymbol;
    sketchViewModel.reset();
    // Call update and pass in the invalid geometry to let the user
    // to correct the invalid update.
    sketchViewModel.update(event.geometry);
  }
});
update-complete
Since: ArcGIS API for JavaScript 4.7

Fires after graphic is updated.

Properties:
geometry Geometry

The updated geometry.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always update-complete.

Example:
sketchViewModel.on("update-complete", function(event){
  // Check if the updated geometry intersects buffer polygon
  if (intersects) {
    // Set the graphic symbol to an invalid symbol to let the user know
    // that the update is not allowed.
    newDevelopmentGraphic.symbol = invalidSymbol;
    sketchViewModel.reset();
    // Call update and pass in the invalid geometry to let user
    // to correct the invalid update.
    sketchViewModel.update(event.geometry);
  }
});
update-init
Since: ArcGIS API for JavaScript 4.8

Fires after user clicks on a graphic to update or when update() method is called.

Properties:
geometry Geometry

The geometry selected for the update operation.

target Object

A reference to the sketch view model object that dispatched the event.

type String

The type of the event. For this event, the type is always update-init.

API Reference search results

NameTypeModule
Loading...