@conterra/ct-mapapps-typings 4.19.0-next.20241108045540 → 4.19.0-next.20241112045346

package/measurement-2d/api.d.ts

@@ -2,7 +2,20 @@ import { Watchable } from 'apprt-core/Types';
 import { Polyline, Polygon } from 'esri/geometry';
 import { SystemOrAreaUnit, SystemOrLengthUnit } from 'esri/core/units';
 
+/**
+ * Measurement mode.
+ * - `off`: No measurement is active.
+ * - `area`: Area measurement is active.
+ * - `distance`: Distance measurement is active.
+ */
 type Measurement2DMode = "off" | "area" | "distance";
+/**
+ * Measurement state.
+ * - `disabled`: Measurement is disabled (corresponds to `off` mode).
+ * - `ready`: Measurement is ready to start.
+ * - `measuring`: Measurement is in progress.
+ * - `measured`: Measurement is finished.
+ */
 type Measurement2DState = "disabled" | "ready" | "measuring" | "measured";
 /**
  * {@link Watchable} properties of {@link Measurement2DModel}.
@@ -18,49 +31,50 @@ interface Measurement2DModelProperties {
     readonly state: Measurement2DState;
     /**
      * Measurement unit is either unit system (metric, imperial) or a specific unit.
-     * Available if the `mode` is set to `area` or `distance`.
+     * Available if the {@link mode} is set to `area` or `distance`.
      */
     readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
     /**
      * Locale specific representation of the length including the unit.
-     * Available if the `mode` is set to `distance`.
+     * Available if the {@link mode} is set to `distance`.
      */
     readonly distance: string;
     /**
      * Locale specific representation of the area including the unit.
-     * Available if the `mode` is set to `area`.
+     * Available if the {@link mode} is set to `area`.
      */
     readonly area: string;
     /**
      * Locale specific representation of the perimeter including the unit.
-     * Available if the `mode` is set to `area`.
+     * Available if the {@link mode} is set to `area`.
      */
     readonly perimeter: string;
     /**
      * The measurement geometry.
-     * Available if the `mode` is set to `area` or `distance`.
+     * Available if the {@link mode} is set to `area` or `distance`.
      * If mode is `area`, the geometry is a polygon.
      * If mode is `distance`, the geometry is a polyline.
      */
     readonly geometry: Polyline | Polygon;
     /**
      * Distance always in meters.
-     * Available if the `mode` is set to `distance`.
+     * Available if the {@link mode} is set to `distance`.
      */
     readonly rawDistance: number;
     /**
      * Area always in square meter.
-     * Available if the `mode` is set to `area`.
+     * Available if the {@link mode} is set to `area`.
      */
     readonly rawArea: number;
     /**
      * Perimeter always in meters.
-     * Available if the `mode` is set to `area`.
+     * Available if the {@link mode} is set to `area`.
      */
     readonly rawPerimeter: number;
 }
 /**
  * A model, providing access to the current measurement state.
+ * It is available as service `measurement-2d.Model`.
  *
  * See {@link Measurement2DModelProperties} for documentation of class members.
  */

package/measurement-3d/api.d.ts

@@ -0,0 +1,71 @@
+import { Watchable } from 'apprt-core/Types';
+import { SystemOrAreaUnit, SystemOrLengthUnit } from 'esri/core/units';
+
+/**
+ * Measurement mode.
+ * - `off`: Measurement is disabled.
+ * - `area`: Area measurement is enabled.
+ * - `distance`: Distance measurement is enabled.
+ */
+type Measurement3DMode = "off" | "area" | "distance";
+/**
+ * Measurement state.
+ * - `disabled`: Measurement is disabled.
+ * - `ready`: Measurement is enabled and ready to start.
+ * - `measuring`: Measurement is in progress.
+ * - `measured`: Measurement is finished.
+ */
+type Measurement3DState = "disabled" | "ready" | "measuring" | "measured";
+/**
+ * {@link Watchable} properties of {@link Measurement3DModel}.
+ */
+interface Measurement3DModelProperties {
+    /**
+     * Measurement mode.
+     */
+    readonly mode: Measurement3DMode;
+    /**
+     * Measurement state.
+     */
+    readonly state: Measurement3DState;
+    /**
+     * Measurement unit is either unit system (metric, imperial) or a specific unit.
+     * Available if the {@link mode} is set to `area` or `distance`.
+     */
+    readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
+    /**
+     * Locale specific representation of the direct distance including the unit.
+     * Available if the {@link mode} is set to `distance`.
+     */
+    directDistance: string;
+    /**
+     * Locale specific representation of the horizontal distance including the unit.
+     * Available if the {@link mode} is set to `distance`.
+     */
+    horizontalDistance: string;
+    /**
+     * Locale specific representation of the vertical distance including the unit.
+     * Available if the {@link mode} is set to `distance`.
+     */
+    verticalDistance: string;
+    /**
+     * Locale specific representation of the area including the unit.
+     * Available if the {@link mode} is set to `area`.
+     */
+    readonly area: string;
+    /**
+     * Locale specific representation of the perimeter including the unit.
+     * Available if the {@link mode} is set to `area`.
+     */
+    readonly perimeter: string;
+}
+/**
+ * A model, providing access to the current measurement state.
+ * It is available as service `measurement-3d.Model`.
+ *
+ * See {@link Measurement3DModelProperties} for documentation of class members.
+ */
+interface Measurement3DModel extends Measurement3DModelProperties, Watchable<Measurement3DModelProperties> {
+}
+
+export type { Measurement3DMode, Measurement3DModel, Measurement3DModelProperties, Measurement3DState };

package/measurement-3d/package.json

@@ -0,0 +1,5 @@
+{
+    "name": "measurement-3d",
+    "version": "4.19.0-SNAPSHOT",
+    "types": ""
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@conterra/ct-mapapps-typings",
-"version": "4.19.0-next.20241108045540",
+"version": "4.19.0-next.20241112045346",
     "description": "TypeDefinitions for ct-mapapps",
     "author": "conterra",
     "license": "Apache-2.0"