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

package/apprt-core/Types.d.ts

@@ -81,11 +81,24 @@ interface EventEmitter<Events> {
      */
     emit<Name extends keyof Events>(name: Name, evt: Events[Name]): void;
 }
+/**
+ * Watch event, this matches the apprt-core/Mutable watch interface.
+ * @param NameType the type of the name of the event.
+ * @param ValueType the type of the value of the event.
+ * @see Watchable
+ */
 interface WatchEvent<NameType, ValueType> {
     value: ValueType;
     name: NameType;
 }
+/**
+ * Watch callback, informed about watch events.
+ */
 type WatchCallback<NameType, ValueType> = (event: WatchEvent<NameType, ValueType>) => void;
+/**
+ * Interface defining a watch method.
+ * It matches the apprt-core/Mutable watch interface.
+ */
 interface Watchable<WatchableProperties> {
     watch<Name extends keyof WatchableProperties>(name: Name, callBack: WatchCallback<Name, WatchableProperties[Name]>): Handle;
 }

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

@@ -0,0 +1,70 @@
+import { Watchable } from 'apprt-core/Types';
+import { Polyline, Polygon } from 'esri/geometry';
+import { SystemOrAreaUnit, SystemOrLengthUnit } from 'esri/core/units';
+
+type Measurement2DMode = "off" | "area" | "distance";
+type Measurement2DState = "disabled" | "ready" | "measuring" | "measured";
+/**
+ * {@link Watchable} properties of {@link Measurement2DModel}.
+ */
+interface Measurement2DModelProperties {
+    /**
+     * Measurement mode.
+     */
+    readonly mode: Measurement2DMode;
+    /**
+     * Measurement state.
+     */
+    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`.
+     */
+    readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
+    /**
+     * Locale specific representation of the length including the unit.
+     * Available if the `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`.
+     */
+    readonly area: string;
+    /**
+     * Locale specific representation of the perimeter including the unit.
+     * Available if the `mode` is set to `area`.
+     */
+    readonly perimeter: string;
+    /**
+     * The measurement geometry.
+     * Available if the `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`.
+     */
+    readonly rawDistance: number;
+    /**
+     * Area always in square meter.
+     * Available if the `mode` is set to `area`.
+     */
+    readonly rawArea: number;
+    /**
+     * Perimeter always in meters.
+     * Available if the `mode` is set to `area`.
+     */
+    readonly rawPerimeter: number;
+}
+/**
+ * A model, providing access to the current measurement state.
+ *
+ * See {@link Measurement2DModelProperties} for documentation of class members.
+ */
+interface Measurement2DModel extends Measurement2DModelProperties, Watchable<Measurement2DModelProperties> {
+}
+
+export type { Measurement2DMode, Measurement2DModel, Measurement2DModelProperties, Measurement2DState };

package/measurement-2d/package.json

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

package/package.json

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