@arcgis/core 5.0.0-next.70 → 5.0.0-next.72

package/widgets/Sketch/types.d.ts

@@ -13,53 +13,106 @@ import type { Icon } from "@esri/calcite-components/components/calcite-icon";
 import type { SymbolUnion } from "../../symbols/types.js";
 import type { DrawingMode } from "../../views/draw/types.js";
 
+/** @since 5.0 */
 export type State = "disabled" | "ready" | "active";
 
+/** @since 5.0 */
 export type SketchCreateEventState = "start" | "active" | "complete" | "cancel";
 
+/** @since 5.0 */
 export type SketchUpdateEventState = "start" | "active" | "complete";
 
+/** @since 5.0 */
 export type Layout = "vertical" | "horizontal";
 
+/** @since 5.0 */
 export type ToolbarKind = "docked" | "floating";
 
+/** @since 5.0 */
 export type SketchTool = CreateTool | UpdateTool;
 
+/** @since 5.0 */
 export type SelectionTool = "lasso-selection" | "rectangle-selection" | "custom-selection";
 
+/** @since 5.0 */
 export type SketchPointSymbol = SimpleMarkerSymbol | PictureMarkerSymbol | PointSymbol3D | TextSymbol | CIMSymbol | WebStyleSymbol;
 
+/** @since 5.0 */
 export type SketchPolylineSymbol = SimpleLineSymbol | LineSymbol3D | CIMSymbol;
 
+/** @since 5.0 */
 export type SketchPolygonSymbol = SimpleFillSymbol | PolygonSymbol3D | CIMSymbol;
 
+/** @since 5.0 */
 export interface UndoEvent {
-  /** An array of graphics that are being updated or created. */
+  /**
+   * An array of graphics that are being updated or created.
+   *
+   * @since 5.0
+   */
   graphics: Graphic[];
-  /** Name of the create or update tool that is active. */
+  /**
+   * Name of the create or update tool that is active.
+   *
+   * @since 5.0
+   */
   tool: CreateTool | UpdateTool;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "undo";
 }
 
+/** @since 5.0 */
 export interface RedoEvent {
-  /** An array of graphics that are being updated or created. */
+  /**
+   * An array of graphics that are being updated or created.
+   *
+   * @since 5.0
+   */
   graphics: Graphic[];
-  /** Name of the create or update tool that is active. */
+  /**
+   * Name of the create or update tool that is active.
+   *
+   * @since 5.0
+   */
   tool: CreateTool | UpdateTool;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "redo";
 }
 
+/** @since 5.0 */
 export type CreationMode = "single" | "continuous" | "update";
 
-/** Options used by the create workflow. */
+/**
+ * Options used by the create workflow.
+ *
+ * @since 5.0
+ */
 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`. */
+  /**
+   * 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`.
+   *
+   * @since 5.0
+   */
   defaultZ?: number;
-  /** The symbol the newly created graphic should use instead of the default symbol for the specified tool. */
+  /**
+   * The symbol the newly created graphic should use instead of the default symbol for the specified tool.
+   *
+   * @since 5.0
+   */
   graphicSymbol?: SymbolUnion;
-  /** Controls whether the created geometry has z-values or not. */
+  /**
+   * Controls whether the created geometry has z-values or not.
+   *
+   * @since 5.0
+   */
   hasZ?: boolean;
   /**
    * Specifies how the graphic can be created. The create mode applies only when creating
@@ -70,24 +123,41 @@ export interface CreateOptions {
    * 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`.
+   *
+   * @since 5.0
    */
   mode?: DrawingMode;
-  /** Controls whether or not the width and height of the drawn geometry are kept equal. Applies to `rectangle` and `circle`. */
+  /**
+   * Controls whether or not the width and height of the drawn geometry are kept equal. Applies to `rectangle` and `circle`.
+   *
+   * @since 5.0
+   */
   preserveAspectRatio?: boolean;
 }
 
-/** Create operation DrawAction tool */
+/**
+ * Create operation DrawAction tool
+ *
+ * @since 5.0
+ */
 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 {@link widgets/Sketch/support/types!VertexAddEventInfo}
- * when the user clicks the view or {@link widgets/Sketch/support/types!CursorUpdateEventInfo} or when the user moves the cursor.
+ * is being created. It returns [VertexAddEventInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-types.html#VertexAddEventInfo)
+ * when the user clicks the view or [CursorUpdateEventInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch-types.html#CursorUpdateEventInfo) or when the user moves the cursor.
+ *
+ * @since 5.0
  */
 export type CreateToolEventInfo = VertexAddEventInfo | VertexRemoveEventInfo | CursorUpdateEventInfo;
 
+/** @since 5.0 */
 export interface CreateEvent {
-  /** The graphic that is being created. */
+  /**
+   * The graphic that is being created.
+   *
+   * @since 5.0
+   */
   graphic?: Graphic | null;
   /**
    * The current state of the event.
@@ -100,29 +170,44 @@ export interface CreateEvent {
    * 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`.
+   *
+   * @since 5.0
    */
   state: SketchCreateEventState;
-  /** Name of the create tool. */
+  /**
+   * Name of the create tool.
+   *
+   * @since 5.0
+   */
   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`.
+   *
+   * @since 5.0
    */
   toolEventInfo?: CreateToolEventInfo | null;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "create";
 }
 
+/** @since 5.0 */
 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
+   * @since 5.0
    */
   multipleSelectionEnabled?: boolean;
 }
 
+/** @since 5.0 */
 export interface ReshapeOptions {
   /**
    * Sets the reshape operation on the edge. This affects lines and polygons. Fully supported in 3D, partially in 2D.
@@ -134,12 +219,14 @@ export interface ReshapeOptions {
    * offset | Manipulators show up to offset the edges. (only 3D)
    *
    * @default "split"
+   * @since 5.0
    */
   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
+   * @since 5.0
    */
   enableCreateCurveFromStraightEdge?: boolean;
   /**
@@ -152,6 +239,7 @@ export interface ReshapeOptions {
    * move-xy | Move manipulator show up to move in xy only. (only 3D)
    *
    * @default "move"
+   * @since 5.0
    */
   shapeOperation?: "none" | "move" | "move-xy";
   /**
@@ -163,21 +251,25 @@ export interface ReshapeOptions {
    * move-xy | Move manipulator show up to move in xy only.
    *
    * @default "move"
+   * @since 5.0
    */
   vertexOperation?: "move" | "move-xy";
 }
 
+/** @since 5.0 */
 export interface TransformOptions {
   /**
    * Indicates if the `rotation` operation will be enabled when updating graphics. Only applies if `tool` is `transform`.
    *
    * @default true
+   * @since 5.0
    */
   enableRotation?: boolean;
   /**
    * Indicates if the `scale` operation will be enabled when updating graphics. Only applies if `tool` is `transform`.
    *
    * @default true
+   * @since 5.0
    */
   enableScaling?: boolean;
   /**
@@ -185,40 +277,55 @@ export interface TransformOptions {
    * 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
+   * @since 5.0
    */
   preserveAspectRatio?: boolean;
 }
 
+/** @since 5.0 */
 export interface HighlightOptions {
   /**
    * Indicates if highlighting is enabled for update operations. Only supported in 2D.
    *
    * @default true
+   * @since 5.0
    */
   enabled?: boolean;
   /**
    * Indicates the name of the highlight group to use.
    *
    * @default "default"
+   * @since 5.0
    */
   name?: string;
 }
 
+/** @since 5.0 */
 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
+   * @since 5.0
    */
   enableZ?: boolean;
-  /** Options that control when to display or hide highlights for update operations. */
+  /**
+   * Options that control when to display or hide highlights for update operations.
+   *
+   * @since 5.0
+   */
   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. */
+  /**
+   * 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.
+   *
+   * @since 5.0
+   */
   reshapeOptions?: ReshapeOptions;
   /**
    * Indicates if the graphic being updated can be toggled between `transform` and `reshape` update options.
    *
    * @default true
+   * @since 5.0
    */
   toggleToolOnClick?: boolean;
   /**
@@ -231,24 +338,41 @@ export interface UpdateOptions extends MoveOptions, TransformOptions {
    * 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 [Sketch#defaultUpdateOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#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.
+   *
+   * @since 5.0
    */
   tool?: UpdateTool;
 }
 
-/** Update operation component */
+/**
+ * Update operation component
+ *
+ * @since 5.0
+ */
 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. */
+/**
+ * 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.
+ *
+ * @since 5.0
+ */
 export type UpdateToolEventInfo = MoveEventInfo | ReshapeEventInfo | RotateEventInfo | ScaleEventInfo | SelectionChangeEventInfo | VertexAddEventInfo | VertexRemoveEventInfo;
 
+/** @since 5.0 */
 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`.
+   *
+   * @since 5.0
    */
   aborted: boolean;
-  /** An array of graphics that are being updated. */
+  /**
+   * An array of graphics that are being updated.
+   *
+   * @since 5.0
+   */
   graphics: Graphic[];
   /**
    * The state of the event.
@@ -260,17 +384,29 @@ export interface UpdateEvent {
    * 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.
+   *
+   * @since 5.0
    */
   state: SketchUpdateEventState;
-  /** Name of the update operation tool. */
+  /**
+   * Name of the update operation tool.
+   *
+   * @since 5.0
+   */
   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`.
+   *
+   * @since 5.0
    */
   toolEventInfo?: UpdateToolEventInfo | null;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "update";
 }
 
@@ -279,6 +415,7 @@ export interface UpdateEvent {
  * event while the user is moving the graphics. It returns additional information associated with the move operation
  * and what stage it is at.
  *
+ * @since 5.0
  * @example
  * // listen to update event
  * sketch.on("update", function(event){
@@ -290,11 +427,23 @@ export interface UpdateEvent {
  * });
  */
 export interface MoveEventInfo {
-  /** Number of pixels moved on the x-axis from the last known position. */
+  /**
+   * Number of pixels moved on the x-axis from the last known position.
+   *
+   * @since 5.0
+   */
   dx: number;
-  /** Number of pixels moved on the y-axis from the last known position. */
+  /**
+   * Number of pixels moved on the y-axis from the last known position.
+   *
+   * @since 5.0
+   */
   dy: number;
-  /** The instance of the graphic that is being moved. */
+  /**
+   * The instance of the graphic that is being moved.
+   *
+   * @since 5.0
+   */
   mover?: Graphic | null;
   /**
    * Returns information indicating the stage of the move operation.
@@ -306,6 +455,8 @@ export interface MoveEventInfo {
    * 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.
+   *
+   * @since 5.0
    */
   type: "move-start" | "move" | "move-stop";
 }
@@ -315,6 +466,7 @@ export interface MoveEventInfo {
  * event while the user is reshaping the graphics. It returns additional information associated with the reshape operation
  * and what stage it is at.
  *
+ * @since 5.0
  * @example
  * // listen to update event
  * sketch.on("update", function(event){
@@ -336,6 +488,8 @@ export interface ReshapeEventInfo {
    * 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.
+   *
+   * @since 5.0
    */
   type: "reshape-start" | "reshape" | "reshape-stop";
 }
@@ -345,6 +499,7 @@ export interface ReshapeEventInfo {
  * event while the user is rotating the graphics. It returns additional information associated with the rotate operation
  * and what stage it is at.
  *
+ * @since 5.0
  * @example
  * // listen to update event
  * sketch.on("update", function(event){
@@ -366,7 +521,11 @@ export interface ReshapeEventInfo {
  * });
  */
 export interface RotateEventInfo {
-  /** Angle of rotation in degrees. */
+  /**
+   * Angle of rotation in degrees.
+   *
+   * @since 5.0
+   */
   angle: number;
   /**
    * Returns information indicating the stage of the rotate operation.
@@ -378,6 +537,8 @@ export interface RotateEventInfo {
    * 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.
+   *
+   * @since 5.0
    */
   type: "rotate-start" | "rotate" | "rotate-stop";
 }
@@ -386,6 +547,8 @@ export interface RotateEventInfo {
  * 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.
+ *
+ * @since 5.0
  */
 export interface ScaleEventInfo {
   /**
@@ -398,20 +561,43 @@ export interface ScaleEventInfo {
    * 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.
+   *
+   * @since 5.0
    */
   type: "scale-start" | "scale" | "scale-stop";
-  /** The x scale factor used to enlarge or shrink the geometry. */
+  /**
+   * The x scale factor used to enlarge or shrink the geometry.
+   *
+   * @since 5.0
+   */
   xScale: number;
-  /** The y scale factor used to enlarge or shrink the geometry. */
+  /**
+   * The y scale factor used to enlarge or shrink the geometry.
+   *
+   * @since 5.0
+   */
   yScale: number;
 }
 
+/** @since 5.0 */
 export interface VertexInfo {
-  /** The ring/path index of the added/removed vertex. */
+  /**
+   * The ring/path index of the added/removed vertex.
+   *
+   * @since 5.0
+   */
   componentIndex: number;
-  /** An array of x,y coordinates representing the vertices added/removed. */
+  /**
+   * An array of x,y coordinates representing the vertices added/removed.
+   *
+   * @since 5.0
+   */
   coordinates: number[];
-  /** The index of the vertex position. */
+  /**
+   * The index of the vertex position.
+   *
+   * @since 5.0
+   */
   vertexIndex: number;
 }
 
@@ -419,6 +605,7 @@ export interface 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)
  * 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.
  *
+ * @since 5.0
  * @example
  * // listen to create event
  * sketch.on("create", function(event){
@@ -430,10 +617,19 @@ export interface VertexInfo {
  * });
  */
 export interface VertexAddEventInfo {
-  /** An array of x,y coordinates representing the vertices added. */
+  /**
+   * An array of x,y coordinates representing the vertices added.
+   *
+   * @since 5.0
+   */
   added: number[] | number[][];
+  /** @since 5.0 */
   type: "vertex-add";
-  /** Contains the details of the added vertices to track changes in topology of the geometry. */
+  /**
+   * Contains the details of the added vertices to track changes in topology of the geometry.
+   *
+   * @since 5.0
+   */
   vertices: VertexInfo[];
 }
 
@@ -441,6 +637,7 @@ export interface VertexAddEventInfo {
  * 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.
  *
+ * @since 5.0
  * @example
  * // listen to update event
  * sketch.on("update", function(event){
@@ -453,10 +650,19 @@ export interface VertexAddEventInfo {
  * });
  */
 export interface VertexRemoveEventInfo {
-  /** An array of x,y coordinates representing the vertices removed. */
+  /**
+   * An array of x,y coordinates representing the vertices removed.
+   *
+   * @since 5.0
+   */
   removed: number[] | number[][];
+  /** @since 5.0 */
   type: "vertex-remove";
-  /** Contains the details of the removed vertices to track changes in topology of the geometry. */
+  /**
+   * Contains the details of the removed vertices to track changes in topology of the geometry.
+   *
+   * @since 5.0
+   */
   vertices: VertexInfo[];
 }
 
@@ -464,6 +670,7 @@ export interface VertexRemoveEventInfo {
  * 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.
  *
+ * @since 5.0
  * @example
  * // listen to create event
  * sketch.on("create", function(event){
@@ -475,8 +682,13 @@ export interface VertexRemoveEventInfo {
  * });
  */
 export interface CursorUpdateEventInfo {
-  /** An array of numbers representing the coordinates of the cursor location. */
+  /**
+   * An array of numbers representing the coordinates of the cursor location.
+   *
+   * @since 5.0
+   */
   coordinates: number[];
+  /** @since 5.0 */
   type: "cursor-update";
 }
 
@@ -484,6 +696,7 @@ export interface CursorUpdateEventInfo {
  * 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`.
  *
+ * @since 5.0
  * @example
  * // listen to update event
  * sketch.on("update", function(event) {
@@ -501,59 +714,150 @@ export interface CursorUpdateEventInfo {
  * });
  */
 export interface SelectionChangeEventInfo {
-  /** An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic selected. */
+  /**
+   * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic selected.
+   *
+   * @since 5.0
+   */
   added: Graphic[];
-  /** An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic deselected. */
+  /**
+   * An array of [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) representing the latest graphic deselected.
+   *
+   * @since 5.0
+   */
   removed: Graphic[];
+  /** @since 5.0 */
   type: "selection-change";
 }
 
-/** Detailed information returned within the delete event. */
+/**
+ * Detailed information returned within the delete event.
+ *
+ * @since 5.0
+ */
 export interface DeleteEvent {
-  /** An array of deleted graphics. */
+  /**
+   * An array of deleted graphics.
+   *
+   * @since 5.0
+   */
   graphics: Graphic[];
-  /** Name of the tool that was active when graphics are deleted. */
+  /**
+   * Name of the tool that was active when graphics are deleted.
+   *
+   * @since 5.0
+   */
   tool: UpdateTool;
-  /** The type of the event. */
+  /**
+   * The type of the event.
+   *
+   * @since 5.0
+   */
   type: "delete";
 }
 
-/** public */
+/**
+ * public
+ *
+ * @since 5.0
+ */
 export interface CustomToolOptions {
-  /** Specific options for the create tool being used by the custom tool. */
+  /**
+   * Specific options for the create tool being used by the custom tool.
+   *
+   * @since 5.0
+   */
   createOptions?: CreateOptions;
-  /** The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for custom tool. */
+  /**
+   * The string value indicating the [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/) displayed for custom tool.
+   *
+   * @since 5.0
+   */
   icon: string;
-  /** The text displayed in the tooltip for the custom tool. */
+  /**
+   * The text displayed in the tooltip for the custom tool.
+   *
+   * @since 5.0
+   */
   label: string;
-  /** The unique identifier string for this custom tool. Value must not overlap with sketch create tool names. */
+  /**
+   * The unique identifier string for this custom tool. Value must not overlap with sketch create tool names.
+   *
+   * @since 5.0
+   */
   toolKey: string;
-  /** The specific sketch create tool to use for the custom tool. */
+  /**
+   * The specific sketch create tool to use for the custom tool.
+   *
+   * @since 5.0
+   */
   toolName: CreateTool;
 }
 
+/** @since 5.0 */
 export interface ActionProperties {
-  /** Controls if the action is rendered with an "active"/pressed appearance */
+  /**
+   * Controls if the action is rendered with an "active"/pressed appearance
+   *
+   * @since 5.0
+   */
   active?: boolean;
-  /** Optional callback called with the HTML element for the action after it is first rendered */
+  /**
+   * Optional callback called with the HTML element for the action after it is first rendered
+   *
+   * @since 5.0
+   */
   afterCreate?: (el: HTMLElement) => void;
-  /** Optional callback called with the HTML element for the calcite-action after it is removed */
+  /**
+   * Optional callback called with the HTML element for the calcite-action after it is removed
+   *
+   * @since 5.0
+   */
   afterRemoved?: (el: HTMLElement) => void;
-  /** Optional callback called with the HTML element for the calcite-action after it is re-rendered with changes */
+  /**
+   * Optional callback called with the HTML element for the calcite-action after it is re-rendered with changes
+   *
+   * @since 5.0
+   */
   afterUpdate?: (el: HTMLElement) => void;
-  /** Controls if the icon should be flipped when the view is in RTL mode. */
+  /**
+   * Controls if the icon should be flipped when the view is in RTL mode.
+   *
+   * @since 5.0
+   */
   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/). */
+  /**
+   * Calcite icon string for the action. MUST be present and MUST be a valid [Calcite icon](https://developers.arcgis.com/calcite-design-system/icons/).
+   *
+   * @since 5.0
+   */
   icon: Icon["icon"];
-  /** Unique ID for the action. MUST be present and MUST be unique. */
+  /**
+   * Unique ID for the action. MUST be present and MUST be unique.
+   *
+   * @since 5.0
+   */
   id: string;
-  /** Optional callback called when the user clicks on the action */
+  /**
+   * Optional callback called when the user clicks on the action
+   *
+   * @since 5.0
+   */
   onclick?: () => void;
-  /** Text label for the action. MUST be present. */
+  /**
+   * Text label for the action. MUST be present.
+   *
+   * @since 5.0
+   */
   text: string;
 }
 
+/** @since 5.0 */
 export interface CustomActionProperties extends ActionProperties {
-  /** Controls where the action will be placed. */
+  /**
+   * Controls where the action will be placed.
+   *
+   * @since 5.0
+   */
   position: "before-selection-set" | "after-selection-set" | "selection-toolbar" | "settings-before" | "settings-after";
 }