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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/measurement-2d/api.d.ts +8 -8
  2. package/measurement-3d/api.d.ts +57 -0
  3. package/measurement-3d/package.json +5 -0
  4. package/package.json +1 -1
package/measurement-2d/api.d.ts CHANGED
@@ -18,44 +18,44 @@ interface Measurement2DModelProperties {
18
18
  readonly state: Measurement2DState;
19
19
  /**
20
20
  * Measurement unit is either unit system (metric, imperial) or a specific unit.
21
- * Available if the `mode` is set to `area` or `distance`.
21
+ * Available if the {@link mode} is set to `area` or `distance`.
22
22
  */
23
23
  readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
24
24
  /**
25
25
  * Locale specific representation of the length including the unit.
26
- * Available if the `mode` is set to `distance`.
26
+ * Available if the {@link mode} is set to `distance`.
27
27
  */
28
28
  readonly distance: string;
29
29
  /**
30
30
  * Locale specific representation of the area including the unit.
31
- * Available if the `mode` is set to `area`.
31
+ * Available if the {@link mode} is set to `area`.
32
32
  */
33
33
  readonly area: string;
34
34
  /**
35
35
  * Locale specific representation of the perimeter including the unit.
36
- * Available if the `mode` is set to `area`.
36
+ * Available if the {@link mode} is set to `area`.
37
37
  */
38
38
  readonly perimeter: string;
39
39
  /**
40
40
  * The measurement geometry.
41
- * Available if the `mode` is set to `area` or `distance`.
41
+ * Available if the {@link mode} is set to `area` or `distance`.
42
42
  * If mode is `area`, the geometry is a polygon.
43
43
  * If mode is `distance`, the geometry is a polyline.
44
44
  */
45
45
  readonly geometry: Polyline | Polygon;
46
46
  /**
47
47
  * Distance always in meters.
48
- * Available if the `mode` is set to `distance`.
48
+ * Available if the {@link mode} is set to `distance`.
49
49
  */
50
50
  readonly rawDistance: number;
51
51
  /**
52
52
  * Area always in square meter.
53
- * Available if the `mode` is set to `area`.
53
+ * Available if the {@link mode} is set to `area`.
54
54
  */
55
55
  readonly rawArea: number;
56
56
  /**
57
57
  * Perimeter always in meters.
58
- * Available if the `mode` is set to `area`.
58
+ * Available if the {@link mode} is set to `area`.
59
59
  */
60
60
  readonly rawPerimeter: number;
61
61
  }
package/measurement-3d/api.d.ts ADDED
@@ -0,0 +1,57 @@
1
+ import { Watchable } from 'apprt-core/Types';
2
+ import { SystemOrAreaUnit, SystemOrLengthUnit } from 'esri/core/units';
3
+
4
+ type Measurement3DMode = "off" | "area" | "distance";
5
+ type Measurement3DState = "disabled" | "ready" | "measuring" | "measured";
6
+ /**
7
+ * {@link Watchable} properties of {@link Measurement3DModel}.
8
+ */
9
+ interface Measurement3DModelProperties {
10
+ /**
11
+ * Measurement mode.
12
+ */
13
+ readonly mode: Measurement3DMode;
14
+ /**
15
+ * Measurement state.
16
+ */
17
+ readonly state: Measurement3DState;
18
+ /**
19
+ * Measurement unit is either unit system (metric, imperial) or a specific unit.
20
+ * Available if the {@link mode} is set to `area` or `distance`.
21
+ */
22
+ readonly unit: SystemOrAreaUnit | SystemOrLengthUnit;
23
+ /**
24
+ * Locale specific representation of the direct distance including the unit.
25
+ * Available if the {@link mode} is set to `distance`.
26
+ */
27
+ directDistance: string;
28
+ /**
29
+ * Locale specific representation of the horizontal distance including the unit.
30
+ * Available if the {@link mode} is set to `distance`.
31
+ */
32
+ horizontalDistance: string;
33
+ /**
34
+ * Locale specific representation of the vertical distance including the unit.
35
+ * Available if the {@link mode} is set to `distance`.
36
+ */
37
+ verticalDistance: string;
38
+ /**
39
+ * Locale specific representation of the area including the unit.
40
+ * Available if the {@link mode} is set to `area`.
41
+ */
42
+ readonly area: string;
43
+ /**
44
+ * Locale specific representation of the perimeter including the unit.
45
+ * Available if the {@link mode} is set to `area`.
46
+ */
47
+ readonly perimeter: string;
48
+ }
49
+ /**
50
+ * A model, providing access to the current measurement state.
51
+ *
52
+ * See {@link Measurement3DModelProperties} for documentation of class members.
53
+ */
54
+ interface Measurement3DModel extends Measurement3DModelProperties, Watchable<Measurement3DModelProperties> {
55
+ }
56
+
57
+ export type { Measurement3DMode, Measurement3DModel, Measurement3DModelProperties, Measurement3DState };
package/measurement-3d/package.json ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "measurement-3d",
3
+ "version": "4.19.0-SNAPSHOT",
4
+ "types": ""
5
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@conterra/ct-mapapps-typings",
3
- "version": "4.19.0-next.20241108045540",
3
+ "version": "4.19.0-next.20241111050921",
4
4
  "description": "TypeDefinitions for ct-mapapps",
5
5
  "author": "conterra",
6
6
  "license": "Apache-2.0"