@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/widgets/Sketch/VisibleElements.d.ts

@@ -0,0 +1,113 @@
+import type Accessor from "../../core/Accessor.js";
+import type SnappingControlsVisibleElements from "../support/SnappingControls/VisibleElements.js";
+import type { CreateToolVisibilityMap, CreateToolVisibilityMapProperties } from "./CreateToolVisibilityMap.js";
+import type { SelectionToolVisibilityMap, SelectionToolVisibilityMapProperties } from "./SelectionToolVisibilityMap.js";
+import type { SnappingControlsVisibleElementsProperties } from "../support/SnappingControls/VisibleElements.js";
+
+export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "deleteButton" | "duplicateButton" | "labelsToggle" | "selectionCountLabel" | "settingsMenu" | "snappingControls" | "tooltipsToggle" | "undoRedoMenu">> {
+  /** The available sketch tools within the widget. */
+  createTools?: CreateToolVisibilityMapProperties;
+  /**
+   * The available selection tools within the widget.
+   * > [!WARNING]
+   * >
+   * > **Known Limitation**
+   * >
+   * > Rectangle and lasso selection is only supported when working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   */
+  selectionTools?: SelectionToolVisibilityMapProperties;
+  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  snappingControlsElements?: SnappingControlsVisibleElementsProperties;
+}
+
+/**
+ * The visible elements that are displayed within the widget.
+ * This provides the ability to turn individual elements of the widget's display on/off.
+ *
+ * @example
+ * // This hides the lasso selection tools
+ * sketch.visibleElements = {
+ *   selectionTools: {
+ *     "lasso-selection": false
+ *   }
+ * }
+ * @example
+ * // This removes the feature enabled snapping toggle and the layerlist.
+ * sketch.visibleElements = {
+ *   snappingControlsElements: {
+ *     featureEnabledToggle: false,
+ *     layerList: false
+ *   }
+ * }
+ * @example
+ * // This hides the undo/redo tools
+ * sketch.visibleElements = {
+ *   undoRedoMenu: false
+ * }
+ */
+export abstract class VisibleElements extends Accessor {
+  /** The available sketch tools within the widget. */
+  get createTools(): CreateToolVisibilityMap;
+  set createTools(value: CreateToolVisibilityMapProperties);
+  /**
+   * 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.
+   *
+   * @default true
+   */
+  accessor deleteButton: boolean;
+  /**
+   * Indicates whether to display the 'duplicate' button while a graphic is selected. Default is `true`.
+   *
+   * @default true
+   */
+  accessor duplicateButton: boolean;
+  /**
+   * _Since 4.29_. Indicates whether to display the sketch labels toggle. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor labelsToggle: boolean;
+  /**
+   * Indicates whether to display a label indicating the length of the currently selected feature set.
+   *
+   * @default true
+   */
+  accessor selectionCountLabel: boolean;
+  /**
+   * The available selection tools within the widget.
+   * > [!WARNING]
+   * >
+   * > **Known Limitation**
+   * >
+   * > Rectangle and lasso selection is only supported when working with a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+   */
+  get selectionTools(): SelectionToolVisibilityMap;
+  set selectionTools(value: SelectionToolVisibilityMapProperties);
+  /**
+   * Indicates whether to display the settings menu. Currently this menu contains snapping options. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor settingsMenu: boolean;
+  /**
+   * Indicates whether to display the `SnappingControls` widget. Default is `true`.
+   *
+   * @default true
+   */
+  accessor snappingControls: boolean;
+  /** The available [SnappingControls](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-support-SnappingControls.html) elements within the widget. */
+  get snappingControlsElements(): SnappingControlsVisibleElements;
+  set snappingControlsElements(value: SnappingControlsVisibleElementsProperties);
+  /**
+   * _Since 4.29_. Indicates whether to display the tooltips toggle. Default value is `true`.
+   *
+   * @default true
+   */
+  accessor tooltipsToggle: boolean;
+  /**
+   * Indicates whether to display the undo/redo menu within the widget. Default is `true`.
+   *
+   * @default true
+   */
+  accessor undoRedoMenu: boolean;
+}

package/widgets/Sketch/support/interfaces.d.ts

@@ -0,0 +1,559 @@
+import type Graphic from "../../../Graphic.js";
+import type CIMSymbol from "../../../symbols/CIMSymbol.js";
+import type LineSymbol3D from "../../../symbols/LineSymbol3D.js";
+import type PictureMarkerSymbol from "../../../symbols/PictureMarkerSymbol.js";
+import type PointSymbol3D from "../../../symbols/PointSymbol3D.js";
+import type PolygonSymbol3D from "../../../symbols/PolygonSymbol3D.js";
+import type SimpleFillSymbol from "../../../symbols/SimpleFillSymbol.js";
+import type SimpleLineSymbol from "../../../symbols/SimpleLineSymbol.js";
+import type SimpleMarkerSymbol from "../../../symbols/SimpleMarkerSymbol.js";
+import type TextSymbol from "../../../symbols/TextSymbol.js";
+import type WebStyleSymbol from "../../../symbols/WebStyleSymbol.js";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { SymbolUnion } from "../../../symbols/support/typeUtils.js";
+import type { DrawingMode } from "../../../views/draw/DrawingMode.js";
+
+export type State = "disabled" | "ready" | "active";
+
+export type SketchCreateEventState = "start" | "active" | "complete" | "cancel";
+
+export type SketchUpdateEventState = "start" | "active" | "complete";
+
+export type Layout = "vertical" | "horizontal";
+
+export type ToolbarKind = "docked" | "floating";
+
+export type SketchTool = CreateTool | UpdateTool;
+
+export type SelectionTool = "lasso-selection" | "rectangle-selection" | "custom-selection";
+
+export type SketchPointSymbol = SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol;
+
+export type SketchPolylineSymbol = SimpleLineSymbol | LineSymbol3D | CIMSymbol;
+
+export type SketchPolygonSymbol = SimpleFillSymbol | PolygonSymbol3D | CIMSymbol;
+
+export interface UndoEvent {
+  /** An array of graphics that are being updated or created. */
+  graphics: Graphic[];
+  /** Name of the create or update tool that is active. */
+  tool: CreateTool | UpdateTool;
+  /** The type of the event. */
+  type: "undo";
+}
+
+export interface RedoEvent {
+  /** An array of graphics that are being updated or created. */
+  graphics: Graphic[];
+  /** Name of the create or update tool that is active. */
+  tool: CreateTool | UpdateTool;
+  /** The type of the event. */
+  type: "redo";
+}
+
+export type CreationMode = "single" | "continuous" | "update";
+
+/** Options used by the create workflow. */
+export interface CreateOptions {
+  /** 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`. */
+  defaultZ?: number;
+  /** The symbol the newly created graphic should use instead of the default symbol for the specified tool. */
+  graphicSymbol?: SymbolUnion;
+  /** Controls whether the created geometry has z-values or not. */
+  hasZ?: boolean;
+  /**
+   * Specifies how the graphic can be created. The create mode applies only when creating
+   * `polygon`, `polyline`, `rectangle` and `circle` geometries.
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * hybrid | Vertices are added while the pointer is clicked or dragged. Applies to `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`.
+   */
+  mode?: DrawingMode;
+  /** Controls whether or not the width and height of the drawn geometry are kept equal. Applies to `rectangle` and `circle`. */
+  preserveAspectRatio?: boolean;
+}
+
+/** Create operation DrawAction tool */
+export type CreateTool = "point" | "multipoint" | "polyline" | "polygon" | "circle" | "rectangle" | "mesh" | "freehandPolyline" | "freehandPolygon" | "text";
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create) event when the graphic
+ * is being created. It returns [VertexAddEventInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-support-interfaces.html#VertexAddEventInfo)
+ * when the user clicks the view or [CursorUpdateEventInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-support-interfaces.html#CursorUpdateEventInfo) or when the user moves the cursor.
+ */
+export type CreateToolEventInfo = VertexAddEventInfo | VertexRemoveEventInfo | CursorUpdateEventInfo;
+
+export interface CreateEvent {
+  /** The graphic that is being created. */
+  graphic?: Graphic | null;
+  /**
+   * The current state of the event.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * start | State changes to `start` when the first vertex is created. Not applicable when creating `points`.
+   * active | State is `active` while feature is being created. Not applicable when creating `points`.
+   * complete | State changes to `complete` after the [Sketch#complete()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#complete) method is called, when the user double clicks, presses the `Enter` key or clicks the first vertex of the `polygon` while creating a feature. When `point` is created, the a single `sketch-create` event is fired with the `complete` state.
+   * cancel | State changes to `cancel` if the user presses the escape key or the [Sketch#create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) or [Sketch#cancel()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#cancel) methods are called during the create operation and before the state changes to `complete`.
+   */
+  state: SketchCreateEventState;
+  /** Name of the create tool. */
+  tool: CreateTool;
+  /**
+   * Returns 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`.
+   */
+  toolEventInfo?: CreateToolEventInfo | null;
+  /** The type of the event. */
+  type: "create";
+}
+
+export interface MoveOptions {
+  /**
+   * Indicates whether more than one selection can be made at once. This applies to the shift+click interaction with the `transform` tool.
+   *
+   * @default true
+   */
+  multipleSelectionEnabled?: boolean;
+}
+
+export interface ReshapeOptions {
+  /**
+   * 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)
+   *
+   * @default "split"
+   */
+  edgeOperation?: "none" | "offset" | "split";
+  /**
+   * _since 5.0_ Indicates if the user can create a circular arc from an existing straight-line edge by holding **`Shift`** while dragging a midpoint handle.
+   *
+   * @default true
+   */
+  enableCreateCurveFromStraightEdge?: boolean;
+  /**
+   * 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)
+   *
+   * @default "move"
+   */
+  shapeOperation?: "none" | "move" | "move-xy";
+  /**
+   * 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.
+   *
+   * @default "move"
+   */
+  vertexOperation?: "move" | "move-xy";
+}
+
+export interface TransformOptions {
+  /**
+   * Indicates if the `rotation` operation will be enabled when updating graphics. Only applies if `tool` is `transform`.
+   *
+   * @default true
+   */
+  enableRotation?: boolean;
+  /**
+   * Indicates if the `scale` operation will be enabled when updating graphics. Only applies if `tool` is `transform`.
+   *
+   * @default true
+   */
+  enableScaling?: boolean;
+  /**
+   * 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](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html).
+   *
+   * @default false
+   */
+  preserveAspectRatio?: boolean;
+}
+
+export interface HighlightOptions {
+  /**
+   * Indicates if highlighting is enabled for update operations. Only supported in 2D.
+   *
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Indicates the name of the highlight group to use.
+   *
+   * @default "default"
+   */
+  name?: string;
+}
+
+export interface UpdateOptions extends MoveOptions, TransformOptions {
+  /**
+   * Indicates if z-values can be modified when updating the graphic. When enabled, the height handle manipulator is displayed.
+   *
+   * @default true
+   */
+  enableZ?: boolean;
+  /** Options that control when to display or hide highlights for update operations. */
+  highlightOptions?: HighlightOptions;
+  /** 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. */
+  reshapeOptions?: ReshapeOptions;
+  /**
+   * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options.
+   *
+   * @default true
+   */
+  toggleToolOnClick?: boolean;
+  /**
+   * Name of the update tool. Specifies the update operation for the selected graphics. The provided tool will become the {@link widgets/Sketch/support/interfaces#activeTool}.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * transform | This is the *default* tool for graphics with a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) geometry, [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry or graphics that use a [3D object symbol layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html) with a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry. It allows one or multiple graphics to be scaled, rotated and moved by default. Its default behavior can be changed by setting the `enableRotation`, `enableScaling` or `preserveAspectRatio` arguments when calling the `update` method or setting them on the {@link widgets/Sketch/support/interfaces#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) or [Polyline](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polyline.html) geometry.
+   * move | This is the *default* tool for graphics with a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) geometry that do not use a [3D object symbol layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-ObjectSymbol3DLayer.html). 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.
+   */
+  tool?: UpdateTool;
+}
+
+/** Update operation component */
+export type UpdateTool = "move" | "transform" | "reshape";
+
+/** This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event when the user is updating graphics. */
+export type UpdateToolEventInfo = MoveEventInfo | ReshapeEventInfo | RotateEventInfo | ScaleEventInfo | SelectionChangeEventInfo | VertexAddEventInfo | VertexRemoveEventInfo;
+
+export interface UpdateEvent {
+  /**
+   * Indicates if the update operation was aborted. Set to `true`
+   * if the user pressed the escape key, or when the [Sketch#update()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update), [Sketch#create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create)
+   * or [Sketch#cancel()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#cancel) method is called before the `update` event's `state` changes to `complete`.
+   */
+  aborted: boolean;
+  /** An array of graphics that are being updated. */
+  graphics: Graphic[];
+  /**
+   * The state of the event.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * start | State changes to `start` 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.
+   */
+  state: SketchUpdateEventState;
+  /** Name of the update operation tool. */
+  tool: UpdateTool;
+  /**
+   * Update operation tool info.
+   * Returns additional information associated with the update operation that is taking place for selected graphics
+   * and what stage it is at. Value of this parameter changes to `null` when the `update` event's `state` changes to `complete`.
+   */
+  toolEventInfo?: UpdateToolEventInfo | null;
+  /** The type of the event. */
+  type: "update";
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update)
+ * event while the user is moving the graphics. It returns additional information associated with the move operation
+ * and what stage it is at.
+ *
+ * @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);
+ *   }
+ * });
+ */
+export interface MoveEventInfo {
+  /** Number of pixels moved on the x-axis from the last known position. */
+  dx: number;
+  /** Number of pixels moved on the y-axis from the last known position. */
+  dy: number;
+  /** The instance of the graphic that is being moved. */
+  mover?: Graphic | null;
+  /**
+   * Returns information indicating the stage of the move operation.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * move-start | The type changes to `move-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.
+   */
+  type: "move-start" | "move" | "move-stop";
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update)
+ * event while the user is reshaping the graphics. It returns additional information associated with the reshape operation
+ * and what stage it is at.
+ *
+ * @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);
+ *   }
+ * });
+ */
+export interface ReshapeEventInfo {
+  /**
+   * Returns information indicating the stage of the reshape operation.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * reshape-start | The type changes to `reshape-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.
+   */
+  type: "reshape-start" | "reshape" | "reshape-stop";
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update)
+ * event while the user is rotating the graphics. It returns additional information associated with the rotate operation
+ * and what stage it is at.
+ *
+ * @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();
+ *         }
+ *       }
+ *     }
+ *   }
+ * });
+ */
+export interface RotateEventInfo {
+  /** Angle of rotation in degrees. */
+  angle: number;
+  /**
+   * Returns information indicating the stage of the rotate operation.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * rotate-start | The type changes to `rotate-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.
+   */
+  type: "rotate-start" | "rotate" | "rotate-stop";
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-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.
+ */
+export interface ScaleEventInfo {
+  /**
+   * Returns information indicating the stage of the scale operation.
+   *
+   * **Possible Values**
+   *
+   * Value | Description |
+   * ----- | ----------- |
+   * scale-start | The type changes to `scale-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.
+   */
+  type: "scale-start" | "scale" | "scale-stop";
+  /** The x scale factor used to enlarge or shrink the geometry. */
+  xScale: number;
+  /** The y scale factor used to enlarge or shrink the geometry. */
+  yScale: number;
+}
+
+export interface VertexInfo {
+  /** The ring/path index of the added/removed vertex. */
+  componentIndex: number;
+  /** An array of x,y coordinates representing the vertices added/removed. */
+  coordinates: number[];
+  /** The index of the vertex position. */
+  vertexIndex: number;
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create)
+ * or [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event when the user adds vertices to the graphic being created or updated.
+ *
+ * @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);
+ *   }
+ * });
+ */
+export interface VertexAddEventInfo {
+  /** An array of x,y coordinates representing the vertices added. */
+  added: number[] | number[][];
+  type: "vertex-add";
+  /** Contains the details of the added vertices to track changes in topology of the geometry. */
+  vertices: VertexInfo[];
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update) event
+ * when the user is removing vertices from the graphic.
+ *
+ * @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);
+ *   }
+ * });
+ */
+export interface VertexRemoveEventInfo {
+  /** An array of x,y coordinates representing the vertices removed. */
+  removed: number[] | number[][];
+  type: "vertex-remove";
+  /** Contains the details of the removed vertices to track changes in topology of the geometry. */
+  vertices: VertexInfo[];
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@create](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-create)
+ * event when the user moves the cursor on the view while the graphic is being created.
+ *
+ * @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]);
+ *   }
+ * });
+ */
+export interface CursorUpdateEventInfo {
+  /** An array of numbers representing the coordinates of the cursor location. */
+  coordinates: number[];
+  type: "cursor-update";
+}
+
+/**
+ * This information is returned as `toolEventInfo` parameter for the [Sketch#@update](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#event-update)
+ * event while the user is selecting or deselecting graphics using `Shift+Left-click`.
+ *
+ * @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);
+ *     }
+ *   }
+ * });
+ */
+export interface SelectionChangeEventInfo {
+  /** An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic selected. */
+  added: Graphic[];
+  /** An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic deselected. */
+  removed: Graphic[];
+  type: "selection-change";
+}
+
+/** Detailed information returned within the delete event. */
+export interface DeleteEvent {
+  /** An array of deleted graphics. */
+  graphics: Graphic[];
+  /** Name of the tool that was active when graphics are deleted. */
+  tool: UpdateTool;
+  /** The type of the event. */
+  type: "delete";
+}
+
+/** public */
+export interface CustomToolOptions {
+  /** Specific options for the create tool being used by the custom tool. */
+  createOptions?: CreateOptions;
+  /** The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for custom tool. */
+  icon: string;
+  /** The text displayed in the tooltip for the custom tool. */
+  label: string;
+  /** The unique identifier string for this custom tool. Value must not overlap with sketch create tool names. */
+  toolKey: string;
+  /** The specific sketch create tool to use for the custom tool. */
+  toolName: CreateTool;
+}
+
+export interface ActionProps {
+  /** Controls if the action is rendered with an "active"/pressed appearance */
+  active?: boolean;
+  /** Optional callback called with the HTML element for the action after it is first rendered */
+  afterCreate?: (el: HTMLElement) => void;
+  /** Optional callback called with the HTML element for the calcite-action after it is removed */
+  afterRemoved?: (el: HTMLElement) => void;
+  /** Optional callback called with the HTML element for the calcite-action after it is re-rendered with changes */
+  afterUpdate?: (el: HTMLElement) => void;
+  /** Controls if the icon should be flipped when the view is in RTL mode. */
+  flipRTL?: boolean;
+  /** Calcite icon string for the action. MUST be present and MUST be a valid [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/). */
+  icon: Icon["icon"];
+  /** Unique ID for the action. MUST be present and MUST be unique. */
+  id: string;
+  /** Optional callback called when the user clicks on the action */
+  onclick?: () => void;
+  /** Text label for the action. MUST be present. */
+  text: string;
+}
+
+export interface CustomActionProps extends ActionProps {
+  /** Controls where the action will be placed. */
+  position: "before-selection-set" | "after-selection-set" | "selection-toolbar" | "settings-before" | "settings-after";
+}