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

package/views/input/types.d.ts

@@ -2,6 +2,7 @@ import type Layer from "../../layers/Layer.js";
 import type Point from "../../geometry/Point.js";
 import type LayerView from "../layers/LayerView.js";
 
+/** @since 5.0 */
 export type PointerType = "mouse" | "touch" | "pen";
 
 /**
@@ -16,21 +17,38 @@ export type PointerType = "mouse" | "touch" | "pen";
  * 3 | back click
  * 4 | forward click
  * -1 | unknown button
+ *
+ * @since 5.0
  */
 export type MouseButton = 0 | 1 | 2 | 3 | 4 | -1;
 
+/** @since 5.0 */
 export interface ViewEvent<T extends Event = Event> {
   /**
    * A function that can be called to defer event propagation until
    * the passed in asynchronous function is completed. Calling defer will stall the entire event pipeline and should
    * be used with caution.
+   *
+   * @since 5.0
    */
   defer: EventDefer;
-  /** A standard [DOM Event](https://developer.mozilla.org/en-US/docs/Web/API/Event). */
+  /**
+   * A standard [DOM Event](https://developer.mozilla.org/en-US/docs/Web/API/Event).
+   *
+   * @since 5.0
+   */
   native: T;
-  /** Time stamp (in milliseconds) at which the event was created. */
+  /**
+   * Time stamp (in milliseconds) at which the event was created.
+   *
+   * @since 5.0
+   */
   timestamp: number;
-  /** Prevents the event bubbling up the event chain. */
+  /**
+   * Prevents the event bubbling up the event chain.
+   *
+   * @since 5.0
+   */
   stopPropagation(): void;
 }
 
@@ -50,6 +68,7 @@ export interface ViewEvent<T extends Event = Event> {
  *     }
  *   });
  * });
+ * @since 5.0
  */
 export type EventDefer = <T>(operation: EventDeferredOperation<T>) => Promise<T>;
 
@@ -58,14 +77,20 @@ export type EventDefer = <T>(operation: EventDeferredOperation<T>) => Promise<T>
  *
  * @returns The event pipeline is deferred until the promise is resolved.
  * @since 4.33
- * @see {@link views/input/IViewEvents!EventDefer}
+ * @see [EventDefer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-input-types.html#EventDefer)
  */
 export type EventDeferredOperation<T> = () => Promise<T>;
 
+/** @since 5.0 */
 export type PointerId = number;
 
+/** @since 5.0 */
 export interface ClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
-  /** Indicates which mouse button was clicked. */
+  /**
+   * Indicates which mouse button was clicked.
+   *
+   * @since 5.0
+   */
   button: MouseButton;
   /**
    * Indicates the current mouse button state.
@@ -75,23 +100,44 @@ export interface ClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
    * 0 | left click (or touch)
    * 1 | middle click
    * 2 | right click
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * The point location of the click on the view in the spatial
    * reference of the map.
+   *
+   * @since 5.0
    */
   mapPoint: Point;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "click";
-  /** The horizontal screen coordinate of the click on the view. */
+  /**
+   * The horizontal screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the click on the view. */
+  /**
+   * The vertical screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface DoubleClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
-  /** Indicates which mouse button was clicked. */
+  /**
+   * Indicates which mouse button was clicked.
+   *
+   * @since 5.0
+   */
   button: MouseButton;
   /**
    * Indicates the current mouse button state.
@@ -101,21 +147,38 @@ export interface DoubleClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
    * 0 | left click (or touch)
    * 1 | middle click
    * 2 | right click
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * The point location of the click on the view in the spatial
    * reference of the map.
+   *
+   * @since 5.0
    */
   mapPoint: Point;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "double-click";
-  /** The horizontal screen coordinate of the click on the view. */
+  /**
+   * The horizontal screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the click on the view. */
+  /**
+   * The vertical screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface ImmediateClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
   /**
    * Indicates which mouse button was clicked.
@@ -126,26 +189,45 @@ export interface ImmediateClickEvent extends ViewEvent<PointerEvent | MouseEvent
    * 0 | left click (or touch)
    * 1 | middle click
    * 2 | right click
+   *
+   * @since 5.0
    */
   button: MouseButton;
   /**
    * Indicates which buttons are pressed when the event is triggered.
    * See [MouseEvent.buttons](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons).
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * The point location of the click on the view in the spatial
    * reference of the map.
+   *
+   * @since 5.0
    */
   mapPoint: Point;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "immediate-click";
-  /** The horizontal screen coordinate of the click on the view. */
+  /**
+   * The horizontal screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the click on the view. */
+  /**
+   * The vertical screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface ImmediateDoubleClickEvent extends ViewEvent<PointerEvent | MouseEvent> {
   /**
    * Indicates which mouse button was clicked.
@@ -156,26 +238,45 @@ export interface ImmediateDoubleClickEvent extends ViewEvent<PointerEvent | Mous
    * 0 | left click (or touch)
    * 1 | middle click
    * 2 | right click
+   *
+   * @since 5.0
    */
   button: MouseButton;
   /**
    * Indicates which buttons are pressed when the event is triggered.
    * See [MouseEvent.buttons](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons).
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * The point location of the click on the view in the spatial
    * reference of the map.
+   *
+   * @since 5.0
    */
   mapPoint: Point;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "immediate-double-click";
-  /** The horizontal screen coordinate of the click on the view. */
+  /**
+   * The horizontal screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the click on the view. */
+  /**
+   * The vertical screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface HoldEvent extends ViewEvent<PointerEvent | MouseEvent> {
   /**
    * Indicates which mouse button was held down.
@@ -186,33 +287,58 @@ export interface HoldEvent extends ViewEvent<PointerEvent | MouseEvent> {
    * 0 | left mouse button (or touch)
    * 1 | middle mouse button
    * 2 | right mouse button
+   *
+   * @since 5.0
    */
   button: MouseButton;
   /**
    * Indicates which mouse buttons are pressed when the event is triggered.
    * See [MouseEvent.buttons](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons).
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * The point location of the click on the view in the spatial
    * reference of the map.
+   *
+   * @since 5.0
    */
   mapPoint: Point;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "hold";
-  /** The horizontal screen coordinate of the hold on the view. */
+  /**
+   * The horizontal screen coordinate of the hold on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the hold on the view. */
+  /**
+   * The vertical screen coordinate of the hold on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface DragEvent extends ViewEvent<PointerEvent | MouseEvent> {
   /**
    * Indicates the state of the drag.
    * The two values `added` and `removed` indicate a change in the number of pointers involved.
+   *
+   * @since 5.0
    */
   action: "start" | "update" | "added" | "removed" | "end";
-  /** Amount of rotation (in degrees) since the last event of type `start`. */
+  /**
+   * Amount of rotation (in degrees) since the last event of type `start`.
+   *
+   * @since 5.0
+   */
   angle: number;
   /**
    * Indicates which mouse button was clicked at the start of the drag.
@@ -223,161 +349,317 @@ export interface DragEvent extends ViewEvent<PointerEvent | MouseEvent> {
    * 0 | left mouse button (or touch)
    * 1 | middle mouse button
    * 2 | right mouse button
+   *
+   * @since 5.0
    */
   button: MouseButton;
   /**
    * Indicates which mouse buttons are pressed when the event is triggered.
    * See [MouseEvent.buttons](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons).
+   *
+   * @since 5.0
    */
   buttons: number;
-  /** Screen coordinates of the start of the drag. */
+  /**
+   * Screen coordinates of the start of the drag.
+   *
+   * @since 5.0
+   */
   origin: DragEventOrigin;
-  /** The radius of a sphere around the multiple pointers involved in this drag. Or 0 while only a single pointer is used. */
+  /**
+   * The radius of a sphere around the multiple pointers involved in this drag. Or 0 while only a single pointer is used.
+   *
+   * @since 5.0
+   */
   radius: number;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "drag";
-  /** The horizontal screen coordinate of the pointer on the view. */
+  /**
+   * The horizontal screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the pointer on the view. */
+  /**
+   * The vertical screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface DragEventOrigin {
-  /** The horizontal screen coordinate of the pointer on the view. */
+  /**
+   * The horizontal screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the pointer on the view. */
+  /**
+   * The vertical screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface KeyDownEvent extends ViewEvent<KeyboardEvent> {
   /**
    * The key value that was pressed, according to the
    * [MDN full list of key values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values).
+   *
+   * @since 5.0
    */
   key: string;
   /**
    * Indicates whether this is the first event emitted
    * due to the key press, or a repeat.
+   *
+   * @since 5.0
    */
   repeat: boolean;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "key-down";
 }
 
+/** @since 5.0 */
 export interface KeyUpEvent extends ViewEvent<KeyboardEvent> {
   /**
    * The key value that was released, according to the
    * [MDN full list of key values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values).
+   *
+   * @since 5.0
    */
   key: string;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "key-up";
 }
 
+/** @since 5.0 */
 export interface PointerEventCommon extends ViewEvent<PointerEvent> {
-  /** Indicates which mouse button was clicked. */
+  /**
+   * Indicates which mouse button was clicked.
+   *
+   * @since 5.0
+   */
   button: MouseButton;
   /**
    * Indicates which mouse buttons are pressed when the event is triggered.
    * See [MouseEvent.buttons](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons).
+   *
+   * @since 5.0
    */
   buttons: number;
   /**
    * Uniquely identifies a pointer between multiple down, move, and up events.
    * Ids might get reused after a pointer-up event.
+   *
+   * @since 5.0
    */
   pointerId: PointerId;
-  /** Indicates the pointer type. */
+  /**
+   * Indicates the pointer type.
+   *
+   * @since 5.0
+   */
   pointerType: PointerType;
-  /** The horizontal screen coordinate of the pointer on the view. */
+  /**
+   * The horizontal screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the pointer on the view. */
+  /**
+   * The vertical screen coordinate of the pointer on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface PointerDownEvent extends PointerEventCommon {
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "pointer-down";
 }
 
+/** @since 5.0 */
 export interface PointerMoveEvent extends PointerEventCommon {
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "pointer-move";
 }
 
+/** @since 5.0 */
 export interface PointerUpEvent extends PointerEventCommon {
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "pointer-up";
 }
 
+/** @since 5.0 */
 export interface PointerEnterEvent extends PointerEventCommon {
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "pointer-enter";
 }
 
+/** @since 5.0 */
 export interface PointerLeaveEvent extends PointerEventCommon {
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "pointer-leave";
 }
 
+/** @since 5.0 */
 export interface ViewMouseWheelEvent extends ViewEvent<WheelEvent> {
-  /** Number representing the vertical scroll amount. */
+  /**
+   * Number representing the vertical scroll amount.
+   *
+   * @since 5.0
+   */
   deltaY: number;
-  /** The event type. */
+  /**
+   * The event type.
+   *
+   * @since 5.0
+   */
   type: "mouse-wheel";
-  /** The horizontal screen coordinate of the click on the view. */
+  /**
+   * The horizontal screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   x: number;
-  /** The vertical screen coordinate of the click on the view. */
+  /**
+   * The vertical screen coordinate of the click on the view.
+   *
+   * @since 5.0
+   */
   y: number;
 }
 
+/** @since 5.0 */
 export interface ViewFocusEvent extends ViewEvent<FocusEvent> {}
 
+/** @since 5.0 */
 export interface ViewBlurEvent extends ViewEvent<FocusEvent> {}
 
+/** @since 5.0 */
 export interface ViewResizeEvent {
-  /** The new measured view height in pixels */
+  /**
+   * The new measured view height in pixels
+   *
+   * @since 5.0
+   */
   height: number;
-  /** The previous view height in pixels */
+  /**
+   * The previous view height in pixels
+   *
+   * @since 5.0
+   */
   oldHeight: number;
-  /** The previous view width in pixels */
+  /**
+   * The previous view width in pixels
+   *
+   * @since 5.0
+   */
   oldWidth: number;
-  /** The new measured view width in pixels */
+  /**
+   * The new measured view width in pixels
+   *
+   * @since 5.0
+   */
   width: number;
 }
 
+/** @since 5.0 */
 export interface LayerViewCreateEvent {
-  /** The layer in the map for which the `layerView` was created. */
+  /**
+   * The layer in the map for which the `layerView` was created.
+   *
+   * @since 5.0
+   */
   layer: Layer;
   /**
    * The LayerView rendered
    *                                                in the view representing the layer in `layer`.
+   *
+   * @since 5.0
    */
   layerView: LayerView;
 }
 
+/** @since 5.0 */
 export interface LayerViewCreateErrorEvent {
-  /** An error object describing why the layer view could not be created. */
+  /**
+   * An error object describing why the layer view could not be created.
+   *
+   * @since 5.0
+   */
   error: Error;
   /**
    * The layer in the map for which the view emitting this event
    *   failed to create a layer view.
+   *
+   * @since 5.0
    */
   layer: Layer;
 }
 
+/** @since 5.0 */
 export interface LayerViewDestroyEvent {
-  /** The layer in the map for which the `layerView` was destroyed. */
+  /**
+   * The layer in the map for which the `layerView` was destroyed.
+   *
+   * @since 5.0
+   */
   layer: Layer;
-  /** The LayerView that was destroyed in the view. */
+  /**
+   * The LayerView that was destroyed in the view.
+   *
+   * @since 5.0
+   */
   layerView: LayerView;
 }
 
+/** @since 5.0 */
 export interface ViewBaseEventTypes {
   /**
    * Fires after each layer in the map has a corresponding [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) created
    * and rendered in the view.
    *
+   * @since 5.0
    * @see [View#whenLayerView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView)
    * @example
    * // This function fires each time a layer view is created for a layer in
@@ -397,6 +679,7 @@ export interface ViewBaseEventTypes {
    * Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
    * after a layer has been added to the map.
    *
+   * @since 5.0
    * @see [View#whenLayerView()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#whenLayerView)
    * @example
    * // This function fires each time an error occurs during the creation of a layerview
@@ -409,11 +692,14 @@ export interface ViewBaseEventTypes {
    * Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) is destroyed and is
    * no longer rendered in the view. This happens for example when a layer is
    * removed from the map of the view.
+   *
+   * @since 5.0
    */
   "layerview-destroy": LayerViewDestroyEvent;
   /**
    * Fires when the view's size changes.
    *
+   * @since 5.0
    * @see [MapView#size](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#size)
    * @see [MapView#height](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#height)
    * @see [MapView#width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#width)
@@ -421,6 +707,7 @@ export interface ViewBaseEventTypes {
   resize: ViewResizeEvent;
 }
 
+/** @since 5.0 */
 export interface ViewEventTypes extends ViewBaseEventTypes {
   /**
    * Fires when browser focus is moved away from the view.
@@ -434,6 +721,7 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
    * event isn't triggered instead. The [View#@immediate-click](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#event-immediate-click) event can be used
    * for responding to a click event without delay.
    *
+   * @since 5.0
    * @see [Sample: Access features with click events](https://developers.arcgis.com/javascript/latest/sample-code/view-hittest/)
    * @example
    * view.on("click", function(event){
@@ -472,6 +760,7 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
   /**
    * Fires after double-clicking on the view.
    *
+   * @since 5.0
    * @example
    * view.on("double-click", function(event) {
    *   // The event object contains the mapPoint and the screen coordinates of the location
@@ -484,6 +773,7 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
   /**
    * Fires during a pointer drag on the view.
    *
+   * @since 5.0
    * @example
    * view.on("drag", function(event){
    *  // Print out the current state of the
@@ -501,6 +791,7 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
   /**
    * Fires after holding either a mouse button or a single finger on the view for a short amount of time.
    *
+   * @since 5.0
    * @example
    * view.on("hold", function(event) {
    *   // The event object contains the mapPoint and the screen coordinates of the location
@@ -540,6 +831,7 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
   /**
    * Fires after a keyboard key is pressed.
    *
+   * @since 5.0
    * @example
    * // Zoom in when user clicks on "a" button
    * // Zoom out when user clicks on "s" button
@@ -565,11 +857,16 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
    * });
    */
   "key-down": KeyDownEvent;
-  /** Fires after a keyboard key is released. */
+  /**
+   * Fires after a keyboard key is released.
+   *
+   * @since 5.0
+   */
   "key-up": KeyUpEvent;
   /**
    * Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.
    *
+   * @since 5.0
    * @example
    * view.on("mouse-wheel", function(event){
    *  // deltaY value is positive when wheel is scrolled up
@@ -578,15 +875,28 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
    * });
    */
   "mouse-wheel": ViewMouseWheelEvent;
-  /** Fires after a mouse button is pressed, or a finger touches the display. */
+  /**
+   * Fires after a mouse button is pressed, or a finger touches the display.
+   *
+   * @since 5.0
+   */
   "pointer-down": PointerDownEvent;
-  /** Fires after a mouse cursor enters the view, or a display touch begins. */
+  /**
+   * Fires after a mouse cursor enters the view, or a display touch begins.
+   *
+   * @since 5.0
+   */
   "pointer-enter": PointerEnterEvent;
-  /** Fires after a mouse cursor leaves the view, or a display touch ends. */
+  /**
+   * Fires after a mouse cursor leaves the view, or a display touch ends.
+   *
+   * @since 5.0
+   */
   "pointer-leave": PointerLeaveEvent;
   /**
    * Fires after the mouse or a finger on the display moves.
    *
+   * @since 5.0
    * @example
    * // Fires `pointer-move` event when user clicks on "Shift"
    * // key and moves the pointer on the view.
@@ -596,6 +906,10 @@ export interface ViewEventTypes extends ViewBaseEventTypes {
    * });
    */
   "pointer-move": PointerMoveEvent;
-  /** Fires after a mouse button is released, or a display touch ends. */
+  /**
+   * Fires after a mouse button is released, or a display touch ends.
+   *
+   * @since 5.0
+   */
   "pointer-up": PointerUpEvent;
 }