@arcgis/core 5.2.0-next.63 → 5.2.0-next.65

package/views/interactive/options/SnappingOptions.d.ts

@@ -0,0 +1,157 @@
+import type Accessor from "../../../core/Accessor.js";
+import type Collection from "../../../core/Collection.js";
+import type FeatureSnappingLayerSource from "../snapping/FeatureSnappingLayerSource.js";
+import type { FeatureSnappingLayerSourceProperties } from "../snapping/FeatureSnappingLayerSource.js";
+import type { ReadonlyArrayOrCollection } from "../../../core/Collection.js";
+
+/** @since 5.2 */
+export interface SnappingOptionsProperties extends Partial<Pick<SnappingOptions, "attributeRulesEnabled" | "distance" | "enabled" | "featureEnabled" | "gridEnabled" | "selfEnabled">> {
+  /**
+   * List of sources for feature snapping. Please refer to [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) for additional information on what layer sources are supported.
+   *
+   * @since 5.2
+   */
+  featureSources?: ReadonlyArrayOrCollection<FeatureSnappingLayerSourceProperties>;
+}
+
+/**
+ * The `SnappingOptions` class allows users to configure snapping for their editing or drawing experience in both the [Sketch.snappingOptions](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#snappingOptions) and [Editor.snappingOptions](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/#snappingOptions) widgets.
+ *
+ * Snapping options provide the ability to specify whether an application will utilize self snapping, feature snapping, or both. Both are described below.
+ *
+ * It is also possible to toggle snapping by pressing and holding down the `CTRL` key. This toggles the snapping on/off.
+ *
+ * #### Self snapping (Geometry guides)
+ * Self snapping is set via the [selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property. This means that while a user is actively creating or updating a feature or graphic, they will see visualizations to help identify perpendicular and parallel lines, in addition to visualizations which aid in snapping to an extension of an existing feature. The following briefly demonstrates what self snapping looks like in a 2D application. Although this is shown for 2D, the same premise applies for 3D as well.
+ *
+ * <video src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-self-2d.webm" aria-label="self-snapping" autoplay muted playsinline loop></video>
+ * #### Feature snapping
+ * Feature snapping is set via the [featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property. It provides the ability to snap vertices of a graphic or feature that is currently being drawn or reshaped to that of an existing feature's vertex, edge, or end point. These existing features belong to layers within the [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) and must be specified in the [featureSources](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureSources) property. The following two images demonstrate feature snapping in a 2D application. Similar to self snapping, the same premise applies for 3D as well.
+ *
+ * <video src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-feature-2d.webm" aria-label="feature-snapping-create" autoplay muted playsinline loop></video>
+ *
+ * The above shows feature snapping to an existing feature's vertex endpoint and edge while creating a new feature. The bottom demonstrates taking an existing feature and reshaping its geometry to snap to another feature's vertex points.
+ *
+ * <video src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-reshape-2d.webm" aria-label="feature-snapping-update" autoplay muted playsinline loop></video>
+ *
+ * > [!WARNING]
+ * >
+ * > **Things to consider:**
+ * > Layer types currently supported for snapping are: [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),
+ * > [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),
+ * > [MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer/) (2D only), [3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/) (3D only), and
+ * > [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) (3D only).
+ * > Snapping is not yet implemented when using the [Sketch widget's](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/) circle tool. It will be addressed in a future release.
+ * > Enabling snapping via the `CTRL` key is not currently supported using the [Sketch widget's](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/) rectangle and circle tools. However, snapping can still be activated by setting the [enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property to `true` in the [Sketch widget](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/) or its [view model](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/). *Note that this enables snapping for all tools. This behavior is subject to change in a future release.*
+ *
+ * Name | Details | 3D Example | 2D Example  |
+ * ---------|---------|----------|:-----------:|
+ * Rectangle | Snap lines that are perpendicular to each other | <img alt="Rectangle" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-rectangle.avif" width="268px"> | <img alt="Rectangle-2d" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-rectangle-2d.avif" width="268px"> |
+ * Parallel | Snap to all parallel lines | <img alt="Parallel" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-parallel.avif" width="268px"> | <img alt="Parallel-2d" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-parallel-2.avif" width="268px"> |
+ * Extension | Snap to an extension of the current shape | <img alt="Extension" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-extension.avif" width="268px"> | <img alt="Extension-2" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-extension-2.avif" width="268px"> |
+ * Vertex (as seen when updating geometries)| Snap vertices to an existing vertex | <img alt="Vertex" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-vertex-3d.avif" width="143px"> | <img alt="Vertex-2" src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sketch/snapping-vertex-2.avif" width="143px"> |
+ *
+ * @since 5.2
+ * @see [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/)
+ * @see [Sketch](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/)
+ * @see [SketchViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/)
+ * @see [Editor](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/)
+ * @see [Sample - Sketch widget](https://developers.arcgis.com/javascript/latest/sample-code/sketch-geometries/)
+ * @see [Sample - Sketch in 3D](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
+ * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/editor-3d/)
+ * @see [Sample - Editor widget with configurations](https://developers.arcgis.com/javascript/latest/sample-code/widgets-editor-configurable/)
+ * @see [Sample - Snapping with Sketch widget and Magnifier](https://developers.arcgis.com/javascript/latest/sample-code/sketch-snapping-magnifier/)
+ * @example
+ * // Create a new instance of Sketch, and set
+ * // a layer for one of the featureSources property.
+ * // This enables feature snapping on that layer.
+ * const sketch = new Sketch({
+ *   layer: graphicsLayer,
+ *   view: view,
+ *   snappingOptions: { // autocasts to SnappingOptions()
+ *     enabled: true, // global snapping is turned on
+ *     // assigns a collection of FeatureSnappingLayerSource() and enables feature snapping on this layer
+ *     featureSources: [{ layer: graphicsLayer, enabled: true }]
+ *   }
+ * });
+ */
+export default class SnappingOptions extends Accessor {
+  /** @since 5.2 */
+  constructor(properties?: SnappingOptionsProperties);
+  /**
+   * When true, enables support for attribute rule-based snapping.
+   * When enabled, resources needed for rule-based snapping, including any Utility Networks present
+   * in the map, will be automatically loaded.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor attributeRulesEnabled: boolean;
+  /**
+   * Snapping distance for snapping in pixels.
+   *
+   * @default 5
+   * @since 5.2
+   */
+  accessor distance: number;
+  /**
+   * Global configuration to turn snapping on or off. Note that snapping is
+   * turned off by default.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor enabled: boolean;
+  /**
+   * Global configuration option to turn feature snapping on or off.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor featureEnabled: boolean;
+  /**
+   * List of sources for feature snapping. Please refer to [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) for additional information on what layer sources are supported.
+   *
+   * @since 5.2
+   */
+  get featureSources(): Collection<FeatureSnappingLayerSource>;
+  set featureSources(value: ReadonlyArrayOrCollection<FeatureSnappingLayerSourceProperties>);
+  /**
+   * Turns the grid on or off. The grid is a network of columns and rows used to divide the view into equal-area squares.
+   * The [GridControls](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/GridControls/) provides a user interface to interact and configure the grid's properties.
+   *
+   * > [!WARNING]
+   * >
+   * > **Note**
+   * >
+   * > It is recommended to wait for the view to be loaded first before setting the `gridEnabled` prop in the [GridControls](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/GridControls/) constructor. The grid is dependent on the view to be loaded first for it to be displayed.
+   * > - This grid is only supported in a 2D [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).
+   *
+   * @default false
+   * @since 5.2
+   * @see [GridControls](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/GridControls/)
+   * @example
+   * // Turn on the grid programmatically for the GridControls.
+   * // Wait for the view to load first.
+   * view.when(() => {
+   *   const gridControls = new GridControls({
+   *     view,
+   *     snappingOptions: {
+   *       enabled: true,
+   *       gridEnabled: true
+   *     }
+   *   });
+   *   // Add GridControls to the view
+   *   view.ui.add(gridControls, "top-left");
+   * });
+   */
+  accessor gridEnabled: boolean;
+  /**
+   * Global configuration option to turn self snapping (within one feature while
+   * either drawing or reshaping) on or off.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor selfEnabled: boolean;
+}

package/views/interactive/options/SnappingOptions.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import t from"../../../core/Accessor.js";import{difference as r}from"../../../core/arrayUtils.js";import o from"../../../core/Collection.js";import i from"../../../core/Logger.js";import{property as a,subclass as n}from"../../../core/accessorSupport/decorators.js";import s from"../snapping/FeatureSnappingLayerSource.js";import{defaults as l}from"../snapping/Settings.js";let u=class extends t{constructor(e){super(e),this.enabled=!1,this.enabledToggled=!1,this.forceDisabled=!1,this.selfEnabled=!0,this.featureEnabled=!0,this.gridEnabled=!1,this.attributeRulesEnabled=!1,this.featureSources=new o,this.distance=l.distance,this.touchSensitivityMultiplier=l.touchSensitivityMultiplier}get effectiveEnabled(){return!this.forceDisabled&&(this.enabledToggled?!this.enabled:this.enabled)}get effectiveGridEnabled(){return this.effectiveEnabled&&this.gridEnabled}get effectiveSelfEnabled(){return this.effectiveEnabled&&this.selfEnabled}get effectiveFeatureEnabled(){return this.effectiveEnabled&&this.featureEnabled}get _effectiveFeatureSources(){const e=this.featureSources;e.some(d)&&i.getLogger(this).warnOnce("Do not configure SubtypeGroupLayer sources in SnappingOptions.featureSources directly. Create a FeatureSnappingLayerSource for each SubtypeSublayer.");const t=e.filter(c),a=this._get("_effectiveFeatureSources")?.filter(d)??new o;for(const r of t){const e=a.find(e=>e.layer===r.layer.parent);if(e)e.sublayerSources.includes(r)||e.sublayerSources.add(r);else if(r.layer.parent){const e=new s({layer:r.layer.parent});e.sublayerSources.add(r),a.add(e)}}for(const r of a){const e=r.sublayerSources.filter(e=>!t.includes(e));r.sublayerSources.removeMany(e)}a.removeMany(a.filter(e=>0===e.sublayerSources.length));const n=e.filter(p),l=this._get("_effectiveFeatureSources")??new o,{added:u,removed:f}=r(l.toArray(),[...n,...a]);return l.removeMany(f),l.addMany(u),l}};function d(e){return"subtype-group"===e.layer.type}function p(e){return"subtype-group"!==e.layer.type}function c(e){return"subtype-sublayer"===e.layer.type}e([a()],u.prototype,"enabled",void 0),e([a()],u.prototype,"enabledToggled",void 0),e([a()],u.prototype,"forceDisabled",void 0),e([a()],u.prototype,"selfEnabled",void 0),e([a()],u.prototype,"featureEnabled",void 0),e([a()],u.prototype,"gridEnabled",void 0),e([a()],u.prototype,"attributeRulesEnabled",void 0),e([a({type:o.ofType(s)})],u.prototype,"featureSources",void 0),e([a()],u.prototype,"distance",void 0),e([a()],u.prototype,"touchSensitivityMultiplier",void 0),e([a({readOnly:!0})],u.prototype,"effectiveEnabled",null),e([a({readOnly:!0})],u.prototype,"effectiveGridEnabled",null),e([a({readOnly:!0})],u.prototype,"effectiveSelfEnabled",null),e([a({readOnly:!0})],u.prototype,"effectiveFeatureEnabled",null),e([a({readOnly:!0})],u.prototype,"_effectiveFeatureSources",null),u=e([n("esri.views.interactive.options.SnappingOptions")],u);export{u as default};

package/views/interactive/options/TooltipOptions.d.ts

@@ -0,0 +1,152 @@
+import type Accessor from "../../../core/Accessor.js";
+import type TooltipVisibleElements from "./TooltipVisibleElements.js";
+import type { Icon } from "@esri/calcite-components/components/calcite-icon";
+import type { ElevationOptions, ElevationOptionsProperties } from "./ElevationOptions.js";
+import type { TooltipVisibleElementsProperties } from "./TooltipVisibleElements.js";
+
+/** @since 5.2 */
+export interface TooltipOptionsProperties extends Partial<Pick<TooltipOptions, "enabled" | "forceEnabled" | "helpMessage" | "helpMessageIcon" | "inputEnabled">> {
+  /**
+   * Configuration for elevation values displayed in the tooltip.
+   *
+   * @internal
+   * @since 5.2
+   */
+  elevation?: ElevationOptionsProperties;
+  /**
+   * The elements that are displayed within the tooltip.
+   *
+   * @since 5.2
+   */
+  visibleElements?: TooltipVisibleElementsProperties;
+}
+
+/**
+ * The `TooltipOptions` class allows users to configure the tooltips which are shown while sketching, editing or placing analyses.
+ *
+ * To enter the tooltip UI's [input mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/TooltipOptions/#inputEnabled),
+ * press the `Tab` key while drawing a new feature, or when editing a point, mesh, or a selected vertex.
+ *
+ * [<video src="https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/editor/editing-constraints.webm" aria-label="sketch-3d-with-constraints" autoplay muted playsinline loop></video>](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
+ *
+ * #### Available tooltip inputs and constraints
+ *
+ * **Direction** field and its respective constraint controls the direction (angle) of a segment (applies to polylines/polygons while drawing).\
+ *    It has two options that can be set either in the tooltip's UI or with
+ *    [valueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/):
+ *    - **Deflection** – **relative** angle that is measured from the previous segment (default).
+ *       Positive values are measured in a clockwise direction. Negative values are measured in a counterclockwise direction.
+ *    - **Direction** – **absolute** angle that is measured clockwise from the main axis of the map (typically north).
+ *
+ * **Distance** field and its respective constraint controls the length of a segment (applies to polylines/polygons while drawing). Distance field is also shown
+ *    when editing an edge offset in SceneView.
+ *
+ * **Coordinates** fields edit the longitude and latitude (in geographic coordinate systems and
+ *    in Web Mercator) or X and Y values (in projected coordinate systems) of a point or a vertex
+ *    of a polyline/polygon.\
+ *    The coordinates can be entered as separate values or as a latitude+longitude pair. In case of the latter,
+ *    the pair can be typed or pasted into either of the two coordinate fields and the input is converted to decimal degree format.
+ *    The coordinates may use DD (decimal degrees), DDM (degrees and decimal minutes), or DMS (degrees, minutes, and seconds) format.
+ *    See more about [supported latitude/longitude strings](https://developers.arcgis.com/javascript/latest/references/core/geometry/coordinateFormatter/#fromLatitudeLongitude).
+ *
+ * **Elevation (Z)** field and its respective constraint edits the Z value of a point or a vertex of a polyline/polygon geometry.\
+ *    When drawing polygon or polyline segments, the Z (elevation) field is locked by default.
+ *    This means that all vertices use the Z value of the first vertex. The constraint can be unlocked in the tooltips' input mode.
+ *
+ * **Orientation** field edits the orientation of a mesh. The angle is measured clockwise from the main axis
+ *    of the map (typically north).\
+ *    Note that the orientation field is connected to the mesh geometry's
+ *    [rotation transform](https://developers.arcgis.com/javascript/latest/references/core/geometry/support/MeshTransform/#rotationAngle) property.
+ *    The latter is an arithmetic rotation which is measured counterclockwise from the 3 o'clock position (typically east).
+ *
+ * **Scale** field edits the scale of a mesh.
+ *
+ * *The following fields are read-only: **Total length** (for polylines only), **Area** (for polygons only),
+ * or fields shown when dragging the manipulators, such as relative **Distance**, **Radius**, relative **Rotation**, relative **Scale**, and **Size**.*
+ *
+ * ##### Considerations when using distance, direction, and deflection constraints
+ *
+ * - In geographic coordinate systems (GCS) and in Web Mercator, the constraints are computed geodetically.
+ * - In projected coordinate systems (PCS), apart from Web Mercator, the constraints are computed in a Euclidean manner (in the respective PCS).
+ * - In 3D, the distance, direction, and deflection constraints are computed on a horizontal plane, dependent on the view's spatial reference.
+ *
+ * #### Available gestures
+ *
+ * Gesture | Action |
+ * ---------|---------|
+ * `Tab` | Activates the input mode and focuses on the next field. |
+ * Input value + `Tab` | Applies the constraint and focuses on the next field.  |
+ * Empty value + `Tab` | Removes the constraint and focuses on the next field.  |
+ * Input value + `Enter` | Applies the constraint and closes the input mode.  |
+ * Empty value + `Enter` | Removes the constraint and closes the input mode.  |
+ * Lock icon | Toggles the constraint on and off. |
+ * `Esc` | Closes the input mode but keeps any applied constraints. |
+ * Left-click-drag (on tooltip header) | Allows to change the position of the tooltip in input mode. |
+ *
+ * @since 5.2
+ * @see [LabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/LabelOptions/)
+ * @see [ValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/)
+ * @see [Sample - Sketch in 3D](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
+ * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/editor-3d/)
+ */
+export default class TooltipOptions extends Accessor {
+  /** @since 5.2 */
+  constructor(properties?: TooltipOptionsProperties);
+  /**
+   * Effective value of `enabled` considering the state of `forceEnabled`.
+   *
+   * @internal
+   */
+  get effectiveEnabled(): boolean;
+  /**
+   * Configuration for elevation values displayed in the tooltip.
+   *
+   * @internal
+   * @since 5.2
+   */
+  get elevation(): ElevationOptions;
+  set elevation(value: ElevationOptionsProperties);
+  /**
+   * Whether tooltips are shown while sketching, editing or placing analyses.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor enabled: boolean;
+  /**
+   * Temporary override option for `enabled`. Can for example be used to allow a keybinding to
+   * temporarily show the tooltips.
+   *
+   * @default false
+   * @internal
+   */
+  accessor forceEnabled: boolean;
+  /**
+   * A custom help message that is displayed at the bottom of the tooltip. If not set, the default
+   * help message based on the current state of the tool is shown.
+   *
+   * @since 5.2
+   */
+  accessor helpMessage: string | null | undefined;
+  /**
+   * An icon that is displayed next to the help message at the bottom of the tooltip. If not set,
+   * the default info icon is shown.
+   *
+   * @since 5.2
+   */
+  accessor helpMessageIcon: Icon["icon"] | null | undefined;
+  /**
+   * Whether users can focus the tooltip and input constraint values.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor inputEnabled: boolean;
+  /**
+   * The elements that are displayed within the tooltip.
+   *
+   * @since 5.2
+   */
+  get visibleElements(): TooltipVisibleElements;
+  set visibleElements(value: TooltipVisibleElementsProperties);
+}

package/views/interactive/options/TooltipOptions.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as e}from"tslib";import o from"../../../core/Accessor.js";import{property as t,subclass as l}from"../../../core/accessorSupport/decorators.js";import{ElevationOptions as i}from"./ElevationOptions.js";import s from"./TooltipVisibleElements.js";let p=class extends o{constructor(e){super(e),this.enabled=!1,this.forceEnabled=!1,this.helpMessage=null,this.helpMessageIcon=null,this.inputEnabled=!0,this.elevation=new i,this.placement="auto",this.offset=null,this.visibleElements=new s,this.visualVariables=null,this.xyMode="auto"}get effectiveEnabled(){return this.forceEnabled||this.enabled}};e([t({type:Boolean,nonNullable:!0})],p.prototype,"enabled",void 0),e([t()],p.prototype,"forceEnabled",void 0),e([t()],p.prototype,"effectiveEnabled",null),e([t()],p.prototype,"helpMessage",void 0),e([t()],p.prototype,"helpMessageIcon",void 0),e([t({type:Boolean,nonNullable:!0})],p.prototype,"inputEnabled",void 0),e([t({type:i,nonNullable:!0})],p.prototype,"elevation",void 0),e([t()],p.prototype,"placement",void 0),e([t()],p.prototype,"offset",void 0),e([t({type:s,nonNullable:!0})],p.prototype,"visibleElements",void 0),e([t()],p.prototype,"visualVariables",void 0),e([t()],p.prototype,"xyMode",void 0),p=e([l("esri.views.interactive.options.TooltipOptions")],p);const n=p;export{n as default};

package/views/interactive/options/TooltipVisibleElements.d.ts

@@ -0,0 +1,105 @@
+import type Accessor from "../../../core/Accessor.js";
+
+/** @since 5.2 */
+export interface TooltipVisibleElementsProperties extends Partial<Pick<TooltipVisibleElements, "area" | "coordinates" | "direction" | "distance" | "elevation" | "header" | "helpMessage" | "orientation" | "radius" | "rotation" | "scale" | "size" | "totalLength">> {}
+
+/**
+ * The elements that are displayed within the tooltip while sketching, editing or placing analyses.
+ *
+ * @since 5.2
+ */
+export default class TooltipVisibleElements extends Accessor {
+  /** @since 5.2 */
+  constructor(properties?: TooltipVisibleElementsProperties);
+  /**
+   * When set to `false`, the area is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor area: boolean;
+  /**
+   * When set to `false`, the coordinate is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor coordinates: boolean;
+  /**
+   * When set to `false`, the direction (or deflection angle) is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor direction: boolean;
+  /**
+   * When set to `false`, the distance is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor distance: boolean;
+  /**
+   * When set to `false`, the elevation is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor elevation: boolean;
+  /**
+   * When set to `false`, the header at the top of the tooltip is not shown, when in input mode.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor header: boolean;
+  /**
+   * When set to `false`, the help message at the bottom of the tooltip is not shown.
+   *
+   * @default false
+   * @since 5.2
+   */
+  accessor helpMessage: boolean;
+  /**
+   * When set to `false`, the orientation is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor orientation: boolean;
+  /**
+   * When set to `false`, the radius is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor radius: boolean;
+  /**
+   * When set to `false`, the rotation is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor rotation: boolean;
+  /**
+   * When set to `false`, the scale is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor scale: boolean;
+  /**
+   * When set to `false`, the size is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor size: boolean;
+  /**
+   * When set to `false`, the total length is not shown in the tooltip.
+   *
+   * @default true
+   * @since 5.2
+   */
+  accessor totalLength: boolean;
+}

package/views/interactive/options/TooltipVisibleElements.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as o}from"tslib";import e from"../../../core/Accessor.js";import{property as t,subclass as l}from"../../../core/accessorSupport/decorators.js";let n=class extends e{constructor(o){super(o),this.area=!0,this.coordinates=!0,this.direction=!0,this.distance=!0,this.elevation=!0,this.header=!0,this.helpMessage=!1,this.orientation=!0,this.radius=!0,this.rotation=!0,this.scale=!0,this.size=!0,this.totalLength=!0}};o([t({type:Boolean,nonNullable:!0})],n.prototype,"area",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"coordinates",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"direction",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"distance",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"elevation",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"header",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"helpMessage",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"orientation",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"radius",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"rotation",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"scale",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"size",void 0),o([t({type:Boolean,nonNullable:!0})],n.prototype,"totalLength",void 0),n=o([l("esri.views.interactive.options.TooltipVisibleElements")],n);const i=n;export{i as default};

package/views/interactive/options/ValueOptions.d.ts

@@ -0,0 +1,63 @@
+import type Accessor from "../../../core/Accessor.js";
+import type Units from "../support/Units.js";
+import type { DirectionMode } from "../support/types.js";
+import type { UnitsProperties } from "../support/Units.js";
+
+/** @since 5.2 */
+export interface ValueOptionsProperties extends Partial<Pick<ValueOptions, "directionMode">> {
+  /**
+   * Units used for displaying values in the UI.
+   *
+   * @since 5.2
+   */
+  displayUnits?: UnitsProperties;
+  /**
+   * Units used for interpreting input values.
+   *
+   * @since 5.2
+   */
+  inputUnits?: UnitsProperties;
+}
+
+/**
+ * The `ValueOptions` class allows users to configure how numerical values and
+ * constraints behave while sketching, editing or placing analyses.
+ *
+ * @since 5.2
+ * @see [LabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/LabelOptions/)
+ * @see [TooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/TooltipOptions/)
+ * @see [Editor](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/)
+ * @see [Sample - Sketch in 3D](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
+ * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/editor-3d/)
+ */
+export default class ValueOptions extends Accessor {
+  /** @since 5.2 */
+  constructor(properties?: ValueOptionsProperties);
+  /**
+   * How direction values are displayed and, in case of input, how they are interpreted.
+   *
+   * - When set to "relative", the direction (also called deflection) is measured relative to the previous segment.
+   *   Positive values are measured in a clockwise direction. Negative values are measured in a counterclockwise direction.
+   * - When set to "absolute", the direction is measured clockwise from the main axis of the map (typically north).
+   *
+   * The direction mode can be toggled in the [tooltip's](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/TooltipOptions/) UI, provided the input mode is active.
+   *
+   * @default "relative"
+   * @since 5.2
+   */
+  accessor directionMode: DirectionMode;
+  /**
+   * Units used for displaying values in the UI.
+   *
+   * @since 5.2
+   */
+  get displayUnits(): Units;
+  set displayUnits(value: UnitsProperties);
+  /**
+   * Units used for interpreting input values.
+   *
+   * @since 5.2
+   */
+  get inputUnits(): Units;
+  set inputUnits(value: UnitsProperties);
+}

package/views/interactive/options/ValueOptions.js

@@ -0,0 +1,2 @@
+/* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
+import{__decorate as t}from"tslib";import e from"../../../core/Accessor.js";import{property as i,subclass as s}from"../../../core/accessorSupport/decorators.js";import o from"../support/Units.js";let r=class extends e{constructor(t){super(t),this.directionMode="relative",this.relativeDirectionIsBilateral=!1}get effectiveDirectionMode(){switch(this.directionMode){case"relative":return this.relativeDirectionIsBilateral?"relative-bilateral":"relative";case"absolute":return"absolute"}}get displayUnits(){return this._get("displayUnits")??new o}set displayUnits(t){this._set("displayUnits",t)}get inputUnits(){return this._get("inputUnits")??new o}set inputUnits(t){this._set("inputUnits",t)}};t([i({type:String,nonNullable:!0})],r.prototype,"directionMode",void 0),t([i({type:Boolean,nonNullable:!0})],r.prototype,"relativeDirectionIsBilateral",void 0),t([i()],r.prototype,"effectiveDirectionMode",null),t([i({type:o,nonNullable:!0})],r.prototype,"displayUnits",null),t([i({type:o,nonNullable:!0})],r.prototype,"inputUnits",null),r=t([s("esri.views.interactive.options.ValueOptions")],r);const n=r;export{n as default};

package/views/interactive/sketch/SketchLabelOptions.d.ts

@@ -1,6 +1,8 @@
-import type Accessor from "../../../core/Accessor.js";
+import type LabelOptions from "../options/LabelOptions.js";
+import type { LabelOptionsProperties } from "../options/LabelOptions.js";
 
-export interface SketchLabelOptionsProperties extends Partial<Pick<SketchLabelOptions, "enabled">> {}
+/** @deprecated since 5.2. Use [LabelOptionsProperties](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/LabelOptions/#LabelOptionsProperties) instead. */
+export interface SketchLabelOptionsProperties extends LabelOptionsProperties {}
 
 /**
  * The `SketchLabelOptions` allows users to configure the labels which are shown next to each
@@ -51,6 +53,7 @@ export interface SketchLabelOptionsProperties extends Partial<Pick<SketchLabelOp
  *
  * </details>
  *
+ * @deprecated since 5.2. Use [LabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/LabelOptions/) instead.
  * @since 4.24
  * @see [Sketch](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/)
  * @see [SketchViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/)
@@ -60,12 +63,7 @@ export interface SketchLabelOptionsProperties extends Partial<Pick<SketchLabelOp
  * @see [Sample - Sketch in 3D](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
  * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/editor-3d/)
  */
-export default class SketchLabelOptions extends Accessor {
+export default class SketchLabelOptions extends LabelOptions {
+  /** @since 5.2 */
   constructor(properties?: SketchLabelOptionsProperties);
-  /**
-   * Whether labels are shown next to each segment of the graphic being sketched.
-   *
-   * @default false
-   */
-  accessor enabled: boolean;
 }

package/views/interactive/sketch/SketchLabelOptions.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{__decorate as e}from"tslib";import o from"../../../core/Accessor.js";import{property as t,subclass as r}from"../../../core/accessorSupport/decorators.js";let s=class extends o{constructor(e){super(e),this.enabled=!1}};e([t({type:Boolean,nonNullable:!0})],s.prototype,"enabled",void 0),s=e([r("esri.views.interactive.sketch.SketchLabelOptions")],s);export{s as default};
+import{__decorate as t}from"tslib";import{subclass as o}from"../../../core/accessorSupport/decorators.js";import s from"../options/LabelOptions.js";let e=class extends s{constructor(t){super(t)}};e=t([o("esri.views.interactive.sketch.SketchLabelOptions")],e);export{e as default};

package/views/interactive/sketch/SketchTooltipElevationOptions.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.2/LICENSE.txt */
-import{__decorate as o}from"tslib";import t from"../../../core/Accessor.js";import{property as e,subclass as r}from"../../../core/accessorSupport/decorators.js";let s=class extends t{constructor(o){super(o),this.mode="absolute-height"}toJSON(){return{mode:this.mode}}};o([e({type:String,nonNullable:!0})],s.prototype,"mode",void 0),s=o([r("esri.views.interactive.sketch.SketchTooltipElevationOptions")],s);export{s as SketchTooltipElevationOptions};
+import{__decorate as o}from"tslib";import{subclass as t}from"../../../core/accessorSupport/decorators.js";import{ElevationOptions as r}from"../options/ElevationOptions.js";let s=class extends r{constructor(o){super(o)}};s=o([t("esri.views.interactive.sketch.SketchTooltipElevationOptions")],s);export{s as SketchTooltipElevationOptions};

package/views/interactive/sketch/SketchTooltipOptions.d.ts

@@ -1,16 +1,11 @@
-import type Accessor from "../../../core/Accessor.js";
-import type SketchTooltipVisibleElements from "./SketchTooltipVisibleElements.js";
-import type { Icon } from "@esri/calcite-components/components/calcite-icon";
-import type { SketchTooltipVisibleElementsProperties } from "./SketchTooltipVisibleElements.js";
+import type TooltipOptions from "../options/TooltipOptions.js";
+import type { TooltipOptionsProperties } from "../options/TooltipOptions.js";
 
-export interface SketchTooltipOptionsProperties extends Partial<Pick<SketchTooltipOptions, "enabled" | "forceEnabled" | "helpMessage" | "helpMessageIcon" | "inputEnabled">> {
-  /** The elements that are displayed within the tooltip while sketching. */
-  visibleElements?: SketchTooltipVisibleElementsProperties;
-}
+/** @deprecated since 5.2. Use [TooltipOptionsProperties](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/TooltipOptions/#TooltipOptionsProperties) instead. */
+export interface SketchTooltipOptionsProperties extends TooltipOptionsProperties {}
 
 /**
- * The `SketchTooltipOptions` allows users to configure the tooltips which are shown while
- * sketching and editing.
+ * The `SketchTooltipOptions` allows users to configure the tooltips which are shown while sketching and editing.
  *
  * To enter the tooltip UI's [input mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/#inputEnabled),
  * press the `Tab` key while drawing a new feature, or when editing a point, mesh, or a selected vertex.
@@ -71,6 +66,7 @@ export interface SketchTooltipOptionsProperties extends Partial<Pick<SketchToolt
  * `Esc` | Closes the input mode but keeps any applied constraints. |
  * Left-click-drag (on tooltip header) | Allows to change the position of the tooltip in input mode. |
  *
+ * @deprecated since 5.2. Use [TooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/TooltipOptions/) instead.
  * @since 4.24
  * @see [Sketch](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/)
  * @see [SketchViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/SketchViewModel/)
@@ -80,45 +76,7 @@ export interface SketchTooltipOptionsProperties extends Partial<Pick<SketchToolt
  * @see [Sample - Sketch in 3D](https://developers.arcgis.com/javascript/latest/sample-code/sketch-3d/)
  * @see [Sample - Edit features in 3D with the Editor widget](https://developers.arcgis.com/javascript/latest/sample-code/editor-3d/)
  */
-export default class SketchTooltipOptions extends Accessor {
+export default class SketchTooltipOptions extends TooltipOptions {
+  /** @since 5.2 */
   constructor(properties?: SketchTooltipOptionsProperties);
-  /**
-   * Effective value of `enabled` considering the state of `forceEnabled`.
-   *
-   * @internal
-   */
-  get effectiveEnabled(): boolean;
-  /**
-   * Whether tooltips are shown while sketching and editing.
-   *
-   * @default false
-   */
-  accessor enabled: boolean;
-  /**
-   * Temporary override option for `enabled`. Can for example be used to allow a keybinding to
-   * temporarily show the tooltips.
-   *
-   * @default false
-   * @internal
-   */
-  accessor forceEnabled: boolean;
-  /**
-   * A custom help message that is displayed at the bottom of the tooltip. If not set, the default
-   * help message based on the current state of the tool is shown.
-   */
-  accessor helpMessage: string | null | undefined;
-  /**
-   * An icon that is displayed next to the help message at the bottom of the tooltip. If not set,
-   * the default info icon is shown.
-   */
-  accessor helpMessageIcon: Icon["icon"] | null | undefined;
-  /**
-   * Whether users can focus the tooltip and input constraint values.
-   *
-   * @default true
-   */
-  accessor inputEnabled: boolean;
-  /** The elements that are displayed within the tooltip while sketching. */
-  get visibleElements(): SketchTooltipVisibleElements;
-  set visibleElements(value: SketchTooltipVisibleElementsProperties);
 }