@vertigis/viewer-spec 59.31.0 → 60.0.0

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 (44) hide show
  1. package/messaging/DotNetTypes.d.ts +11 -0
  2. package/messaging/registry/Operations.d.ts +0 -7
  3. package/messaging/registry/Operations.js +1 -1
  4. package/messaging/registry/app.d.ts +1 -20
  5. package/messaging/registry/app.js +1 -1
  6. package/messaging/registry/arcade.d.ts +2 -2
  7. package/messaging/registry/auth.d.ts +3 -3
  8. package/messaging/registry/basemap.d.ts +4 -3
  9. package/messaging/registry/bulk-editing.d.ts +2 -7
  10. package/messaging/registry/charts.d.ts +1 -1
  11. package/messaging/registry/display.d.ts +2 -2
  12. package/messaging/registry/drawing.d.ts +2 -2
  13. package/messaging/registry/edit.d.ts +25 -27
  14. package/messaging/registry/file.d.ts +3 -3
  15. package/messaging/registry/geolocation.d.ts +80 -9
  16. package/messaging/registry/highlights.d.ts +0 -19
  17. package/messaging/registry/highlights.js +1 -1
  18. package/messaging/registry/layers.d.ts +1 -1
  19. package/messaging/registry/layout.d.ts +1 -5
  20. package/messaging/registry/licensing.d.ts +2 -2
  21. package/messaging/registry/location-marker.d.ts +1 -2
  22. package/messaging/registry/map.d.ts +5 -5
  23. package/messaging/registry/measurement.d.ts +1 -1
  24. package/messaging/registry/network.d.ts +2 -2
  25. package/messaging/registry/printing.d.ts +10 -10
  26. package/messaging/registry/reports.d.ts +1 -1
  27. package/messaging/registry/results.d.ts +6 -5
  28. package/messaging/registry/sketching.d.ts +9 -96
  29. package/messaging/registry/sketching.js +1 -1
  30. package/messaging/registry/system.d.ts +1 -1
  31. package/messaging/registry/tasks.d.ts +2 -1
  32. package/messaging/registry/tracing.d.ts +1 -1
  33. package/messaging/registry/ui.d.ts +1 -1
  34. package/messaging/schema/common-action.schema.json +23 -98
  35. package/messaging/schema/common-event.schema.json +5 -4
  36. package/messaging/schema/mobile-action.schema.json +29 -121
  37. package/messaging/schema/mobile-event.schema.json +41 -43
  38. package/messaging/schema/web-action.schema.json +56 -392
  39. package/messaging/schema/web-event.schema.json +17 -16
  40. package/package.json +1 -1
  41. package/version.d.ts +1 -1
  42. package/version.js +1 -1
  43. package/messaging/registry/debugConsole.d.ts +0 -26
  44. package/messaging/registry/debugConsole.js +0 -1
@@ -1,7 +1,18 @@
1
+ /**
2
+ * {@link https://learn.microsoft.com/en-us/dotnet/api/system.timespan?view=net-9.0}.
3
+ */
1
4
  export interface TimeSpan {
2
5
  }
6
+ /**
7
+ * {@link https://learn.microsoft.com/en-us/dotnet/api/system.consolekeyinfo?view=net-9.0}.
8
+ */
3
9
  export interface ConsoleKeyInfo {
4
10
  }
11
+ /**
12
+ * {@link https://learn.microsoft.com/en-us/dotnet/api/system.windows.thickness?view=windowsdesktop-9.0}.
13
+ */
14
+ export interface Thickness {
15
+ }
5
16
  /**
6
17
  * {https://learn.microsoft.com/en-us/dotnet/api/system.datetime}.
7
18
  */
@@ -4,7 +4,6 @@ import { ArcadeOperations } from "./arcade.js";
4
4
  import { AuthOperations } from "./auth.js";
5
5
  import { BasemapOperations } from "./basemap.js";
6
6
  import { ChartOperations } from "./charts.js";
7
- import { DebugConsoleOperations } from "./debugConsole.js";
8
7
  import { DrawingOperations } from "./drawing.js";
9
8
  import { EditOperations } from "./edit.js";
10
9
  import { FileOperations } from "./file.js";
@@ -12,7 +11,6 @@ import { FilterBuilderOperations } from "./filter-builder.js";
12
11
  import { GeocodeOperations } from "./geocode.js";
13
12
  import { GeolocationOperations } from "./geolocation.js";
14
13
  import { GeometryOperations } from "./geometry.js";
15
- import { HighlightsOperations } from "./highlights.js";
16
14
  import { KpiOperations } from "./kpi.js";
17
15
  import { LayersOperations } from "./layers.js";
18
16
  import { LicensingOperations } from "./licensing.js";
@@ -47,7 +45,6 @@ export declare class Operations extends OperationRegistry {
47
45
  readonly geocode: GeocodeOperations;
48
46
  readonly geolocation: GeolocationOperations;
49
47
  readonly geometry: GeometryOperations;
50
- readonly highlights: HighlightsOperations;
51
48
  readonly kpi: KpiOperations;
52
49
  readonly layers: LayersOperations;
53
50
  readonly licensing: LicensingOperations;
@@ -69,9 +66,5 @@ export declare class Operations extends OperationRegistry {
69
66
  readonly utilityNetwork: UtilityNetworkOperations;
70
67
  readonly viewer: ViewerOperations;
71
68
  readonly workflow: WorkflowOperations;
72
- /**
73
- * @deprecated
74
- */
75
- readonly debugConsole: DebugConsoleOperations;
76
69
  protected readonly _prefix = "";
77
70
  }
@@ -1 +1 @@
1
- import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as m}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as r}from"./basemap.js";import{ChartOperations as t}from"./charts.js";import{DebugConsoleOperations as o}from"./debugConsole.js";import{DrawingOperations as a}from"./drawing.js";import{EditOperations as n}from"./edit.js";import{FileOperations as g}from"./file.js";import{FilterBuilderOperations as p}from"./filter-builder.js";import{GeocodeOperations as w}from"./geocode.js";import{GeolocationOperations as f}from"./geolocation.js";import{GeometryOperations as h}from"./geometry.js";import{HighlightsOperations as j}from"./highlights.js";import{KpiOperations as _}from"./kpi.js";import{LayersOperations as l}from"./layers.js";import{LicensingOperations as u}from"./licensing.js";import{LogViewerOperations as c}from"./logViewer.js";import{MapOperations as d}from"./map.js";import{MeasurementOperations as k}from"./measurement.js";import{MessagingOperations as y}from"./messaging.js";import{NetworkOperations as b}from"./network.js";import{OfflineOperations as x}from"./offline.js";import{PortalOperations as q}from"./portal.js";import{PrintOperations as v}from"./printing.js";import{ProjectOperations as B}from"./project.js";import{QueryBuilderOperations as C}from"./query-builder.js";import{ResultsOperations as O}from"./results.js";import{SketchingOperations as V}from"./sketching.js";import{SystemOperations as N}from"./system.js";import{TasksOperations as R}from"./tasks.js";import{UIOperations as z}from"./ui.js";import{UtilityNetworkOperations as A}from"./utility-network.js";import{ViewerOperations as D}from"./viewer.js";import{WorkflowOperations as E}from"./workflow.js";export class Operations extends s{arcade=new m(this._messages);auth=new i(this._messages);app=new e(this._messages);basemap=new r(this._messages);charts=new t(this._messages);edit=new n(this._messages);drawing=new a(this._messages);file=new g(this._messages);filterBuilder=new p(this._messages);geocode=new w(this._messages);geolocation=new f(this._messages);geometry=new h(this._messages);highlights=new j(this._messages);kpi=new _(this._messages);layers=new l(this._messages);licensing=new u(this._messages);logViewer=new c(this._messages);map=new d(this._messages);measurement=new k(this._messages);messaging=new y(this._messages);network=new b(this._messages);offline=new x(this._messages);portal=new q(this._messages);printing=new v(this._messages);project=new B(this._messages);queryBuilder=new C(this._messages);sketching=new V(this._messages);system=new N(this._messages);results=new O(this._messages);tasks=new R(this._messages);ui=new z(this._messages);utilityNetwork=new A(this._messages);viewer=new D(this._messages);workflow=new E(this._messages);debugConsole=new o(this._messages);_prefix=""}
1
+ import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as m}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as r}from"./basemap.js";import{ChartOperations as t}from"./charts.js";import{DrawingOperations as o}from"./drawing.js";import{EditOperations as a}from"./edit.js";import{FileOperations as n}from"./file.js";import{FilterBuilderOperations as g}from"./filter-builder.js";import{GeocodeOperations as p}from"./geocode.js";import{GeolocationOperations as w}from"./geolocation.js";import{GeometryOperations as f}from"./geometry.js";import{KpiOperations as h}from"./kpi.js";import{LayersOperations as j}from"./layers.js";import{LicensingOperations as _}from"./licensing.js";import{LogViewerOperations as l}from"./logViewer.js";import{MapOperations as u}from"./map.js";import{MeasurementOperations as c}from"./measurement.js";import{MessagingOperations as d}from"./messaging.js";import{NetworkOperations as k}from"./network.js";import{OfflineOperations as y}from"./offline.js";import{PortalOperations as b}from"./portal.js";import{PrintOperations as x}from"./printing.js";import{ProjectOperations as q}from"./project.js";import{QueryBuilderOperations as v}from"./query-builder.js";import{ResultsOperations as B}from"./results.js";import{SketchingOperations as O}from"./sketching.js";import{SystemOperations as V}from"./system.js";import{TasksOperations as N}from"./tasks.js";import{UIOperations as R}from"./ui.js";import{UtilityNetworkOperations as z}from"./utility-network.js";import{ViewerOperations as A}from"./viewer.js";import{WorkflowOperations as C}from"./workflow.js";export class Operations extends s{arcade=new m(this._messages);auth=new i(this._messages);app=new e(this._messages);basemap=new r(this._messages);charts=new t(this._messages);edit=new a(this._messages);drawing=new o(this._messages);file=new n(this._messages);filterBuilder=new g(this._messages);geocode=new p(this._messages);geolocation=new w(this._messages);geometry=new f(this._messages);kpi=new h(this._messages);layers=new j(this._messages);licensing=new _(this._messages);logViewer=new l(this._messages);map=new u(this._messages);measurement=new c(this._messages);messaging=new d(this._messages);network=new k(this._messages);offline=new y(this._messages);portal=new b(this._messages);printing=new x(this._messages);project=new q(this._messages);queryBuilder=new v(this._messages);sketching=new O(this._messages);system=new V(this._messages);results=new B(this._messages);tasks=new N(this._messages);ui=new R(this._messages);utilityNetwork=new z(this._messages);viewer=new A(this._messages);workflow=new C(this._messages);_prefix=""}
@@ -1,4 +1,3 @@
1
- import type { AppConfig } from "../../app-config/index.js";
2
1
  import type { Command } from "../Command.js";
3
2
  import { CommandRegistry } from "../CommandRegistry.js";
4
3
  import type * as DotNetTypes from "../DotNetTypes.js";
@@ -6,7 +5,6 @@ import type { Event } from "../Event.js";
6
5
  import { EventRegistry } from "../EventRegistry.js";
7
6
  import type { Operation } from "../Operation.js";
8
7
  import { OperationRegistry } from "../OperationRegistry.js";
9
- import type { Blob } from "../common.js";
10
8
  /**
11
9
  * Information about a specific app. Only available in VertiGIS Studio Mobile.
12
10
  */
@@ -89,15 +87,6 @@ export declare class AppCommands extends CommandRegistry {
89
87
  * @mobileOnly
90
88
  */
91
89
  get unfavorite(): Command;
92
- /**
93
- * Loads a project's app config and updates the application's current state,
94
- * accordingly. If more than one file is provided, only the first will be
95
- * loaded. Deprecated; use project.load instead. Web only.
96
- *
97
- * @deprecated
98
- * @webOnly
99
- */
100
- get loadProject(): Command<AppConfig | Blob | Blob[]>;
101
90
  }
102
91
  export declare class AppEvents extends EventRegistry {
103
92
  readonly custom: AppCustomEvents;
@@ -117,7 +106,7 @@ export declare class AppEvents extends EventRegistry {
117
106
  */
118
107
  get backgrounded(): Event;
119
108
  /**
120
- * Raised when the app is interrupted temporarily (eg. Pull down
109
+ * Raised when the app is interrupted temporarily (e.g. Pull down
121
110
  * notifications, control center, or OS level prompt or alert). Mobile
122
111
  * only.
123
112
  *
@@ -203,14 +192,6 @@ export declare class AppOperations extends OperationRegistry {
203
192
  * @webOnly
204
193
  */
205
194
  get getVersion(): Operation<void, string>;
206
- /**
207
- * Creates app config for a project, based on the current state of the
208
- * application. Deprecated; use project.create instead. Web only.
209
- *
210
- * @deprecated
211
- * @webOnly
212
- */
213
- get createProject(): Operation<void, AppConfig>;
214
195
  /**
215
196
  * Gets stored data, specified by the arguments (key and scope).
216
197
  */
@@ -1 +1 @@
1
- import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class AppCommands extends e{_prefix="app";get goToAppSelector(){return this._get("go-to-app-selector")}get refresh(){return this._get("refresh")}get setPersistentData(){return this._get("set-persistent-data")}get favorite(){return this._get("favorite")}get unfavorite(){return this._get("unfavorite")}get loadProject(){return this._get("load-project")}}export class AppEvents extends t{custom=new AppCustomEvents(this._messages);generic=new AppGenericEvents(this._messages);_prefix="app";get activated(){return this._get("activated")}get backgrounded(){return this._get("backgrounded")}get interrupted(){return this._get("interrupted")}get goingToAppSelector(){return this._get("navigating-to-app-selector")}get refreshed(){return this._get("refreshed")}get refreshing(){return this._get("refreshing")}get favorited(){return this._get("favorited")}get unfavorited(){return this._get("unfavorited")}}export class AppCustomEvents extends t{_prefix="app.custom";get started(){return this._get("started")}}export class AppGenericEvents extends t{_prefix="app.generic";get appsListed(){return this._get("apps-listed")}get specificAppStarting(){return this._get("generic.specific-app-starting")}get specificAppStarted(){return this._get("generic.specific-app-started")}get started(){return this._get("generic.started")}}export class AppOperations extends r{_prefix="app";get getVersion(){return this._get("get-version")}get createProject(){return this._get("create-project")}get getPersistentData(){return this._get("get-persistent-data")}get removePersistentData(){return this._get("remove-persistent-data")}}
1
+ import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class AppCommands extends e{_prefix="app";get goToAppSelector(){return this._get("go-to-app-selector")}get refresh(){return this._get("refresh")}get setPersistentData(){return this._get("set-persistent-data")}get favorite(){return this._get("favorite")}get unfavorite(){return this._get("unfavorite")}}export class AppEvents extends t{custom=new AppCustomEvents(this._messages);generic=new AppGenericEvents(this._messages);_prefix="app";get activated(){return this._get("activated")}get backgrounded(){return this._get("backgrounded")}get interrupted(){return this._get("interrupted")}get goingToAppSelector(){return this._get("navigating-to-app-selector")}get refreshed(){return this._get("refreshed")}get refreshing(){return this._get("refreshing")}get favorited(){return this._get("favorited")}get unfavorited(){return this._get("unfavorited")}}export class AppCustomEvents extends t{_prefix="app.custom";get started(){return this._get("started")}}export class AppGenericEvents extends t{_prefix="app.generic";get appsListed(){return this._get("apps-listed")}get specificAppStarting(){return this._get("generic.specific-app-starting")}get specificAppStarted(){return this._get("generic.specific-app-started")}get started(){return this._get("generic.started")}}export class AppOperations extends r{_prefix="app";get getVersion(){return this._get("get-version")}get getPersistentData(){return this._get("get-persistent-data")}get removePersistentData(){return this._get("remove-persistent-data")}}
@@ -23,7 +23,7 @@ export interface RunArcadeArgs extends HasMaps, HasLayers, HasFeatures {
23
23
  * which can be referenced from within the executeScript and
24
24
  * canExecuteScript. Note that context variables will be passed in if
25
25
  * available under the well known arcade variable names: $feature,
26
- * $features, $map, and $layer and $featuremap a constructed arcade
26
+ * $features, $map, $layer and $featuremap which is a constructed Arcade
27
27
  * dictionary that exposes a feature mapping dictionary keyed via feature
28
28
  * source ID with the following values: id, title and features.
29
29
  *
@@ -67,7 +67,7 @@ export interface ItemPropertyPath {
67
67
  export declare class ArcadeOperations extends OperationRegistry {
68
68
  protected readonly _prefix = "arcade";
69
69
  /**
70
- * Runs a stringified Arcade script.
70
+ * Runs a stringified Arcade script. Web only.
71
71
  *
72
72
  * - If only a string is passed in as an argument, it is interpreted as an
73
73
  * executeScript.
@@ -40,7 +40,7 @@ export interface SignInEventArgs {
40
40
  */
41
41
  requestInfo: unknown;
42
42
  /**
43
- * The type of Portal: AGOL or Enterprise.
43
+ * The type of Portal: AGOL or ArcGISEnterprise.
44
44
  */
45
45
  portalType: PortalType;
46
46
  }
@@ -75,13 +75,13 @@ export declare class AuthCommands extends CommandRegistry {
75
75
  * Initiates user sign-in if they aren't already signed in. The argument
76
76
  * indicates whether or not the map should be reloaded when the sign-in is
77
77
  * complete. This argument is optional and only supported by VertiGIS Studio
78
- * Mobile.
78
+ * Mobile. Default is true.
79
79
  */
80
80
  get signIn(): Command<boolean | void>;
81
81
  /**
82
82
  * Signs the user out. The argument indicates whether or not the map should
83
83
  * be reloaded when the sign-out is complete. This argument is optional and
84
- * only supported by VertiGIS Studio Mobile.
84
+ * only supported by VertiGIS Studio Mobile. Default is true.
85
85
  */
86
86
  get signOut(): Command<boolean | void>;
87
87
  }
@@ -34,13 +34,14 @@ export declare class BasemapOperations extends OperationRegistry {
34
34
  }
35
35
  /**
36
36
  * Argument used in case when we have only 1 map in the app or when the first
37
- * active map should be used. Basemap extension ID or the basemap self. If more
38
- * than one basemap is specified, only the first one is used.
37
+ * active map should be used. Basemap extension ID or the basemap itself. If
38
+ * more than one basemap is specified, only the first one is used.
39
39
  */
40
40
  export type SetBasemapArg = string | BasemapsLike;
41
41
  /**
42
42
  * Argument used in case when we have more than 1 map in the app, and we need to
43
- * pass the target map from outside (eg basemap picker in VertiGIS Studio Web).
43
+ * pass the target map from outside (e.g. basemap picker in VertiGIS Studio
44
+ * Web).
44
45
  */
45
46
  export interface SetBasemapWithTargetMapArg {
46
47
  /**
@@ -5,16 +5,11 @@ import type { Features, HasFeatures } from "../common.js";
5
5
  * Arguments for the "bulk-editing" commands. Web only.
6
6
  */
7
7
  export type BulkEditingArgs = Features | HasFeatures;
8
- /**
9
- * Commands for managing bulk editing functionality in ViewerSpec.
10
- *
11
- * Core bulk editing functionality is handled by the edit registry.
12
- */
13
8
  export declare class BulkEditingCommands extends CommandRegistry {
14
9
  protected readonly _prefix = "bulk-editing";
15
10
  /**
16
- * Adds features to the bulk editing session. Typically used to stage
17
- * features for later bulk updates. Web only.
11
+ * Adds features to the bulk editing session. Used to stage features for
12
+ * updating. Web only.
18
13
  *
19
14
  * @webOnly
20
15
  */
@@ -29,7 +29,7 @@ export declare class ChartsCommands extends CommandRegistry {
29
29
  protected readonly _prefix = "charts";
30
30
  /**
31
31
  * Updates charts with provided features. Only activated charts that receive
32
- * features from all required feature sources will displayed. Web only.
32
+ * features from all required feature sources will get displayed. Web only.
33
33
  *
34
34
  * @webOnly
35
35
  */
@@ -8,8 +8,8 @@ export interface ElementTranslationStartedArgs {
8
8
  export declare class DisplayEvents extends EventRegistry {
9
9
  protected readonly _prefix = "display";
10
10
  /**
11
- * Raised when one UI element is being moved overtop of another, such that
12
- * the element underneath is partially or fully obscured. Mobile only.
11
+ * Raised when one UI element is being moved overtop another, such that the
12
+ * element underneath is partially or fully obscured. Mobile only.
13
13
  *
14
14
  * @mobileOnly
15
15
  */
@@ -48,8 +48,8 @@ export interface EditSymbolArgs extends HasSymbol, HasSymbols, HasMaps, HasLayer
48
48
  /**
49
49
  * If the fine-grain controls should be hidden and only the symbol presets
50
50
  * should be shown. If no valid symbol presets are configured, this property
51
- * will be ignored. Default is false. If defined, this will override the
52
- * value of the DrawService's 'showOnlySymbolPresets' property.
51
+ * will be ignored. If defined, this will override the value of the
52
+ * DrawService's 'showOnlySymbolPresets' property. Default is false.
53
53
  */
54
54
  showOnlySymbolPresets?: boolean;
55
55
  }
@@ -11,18 +11,16 @@ import { OperationRegistry } from "../OperationRegistry.js";
11
11
  import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
12
12
  import type { EditGeometryOptions } from "./sketching.js";
13
13
  /**
14
- * Arguments for the "edit.add-attachment" command. Supported by both Web and
15
- * Mobile.
14
+ * Arguments for the "edit.add-attachment" command. "Features" is the feature(s)
15
+ * the attachment is being added to.
16
16
  */
17
- export interface AddAttachmentArgs {
17
+ export interface AddAttachmentArgs extends HasFeatures {
18
18
  /**
19
19
  * The map.
20
+ *
21
+ * @deprecated Unused property - will be removed in future versions.
20
22
  */
21
23
  maps: MapsLike;
22
- /**
23
- * The feature(s) to add the attachment to.
24
- */
25
- features: Feature[];
26
24
  /**
27
25
  * The name of the attachment.
28
26
  */
@@ -48,7 +46,7 @@ export interface WebAddAttachmentArgs {
48
46
  features: Features;
49
47
  /**
50
48
  * The blob(s) that contains the file attachment(s). If multiple attachments
51
- * are specified, all attachment will be added to the feature(s).
49
+ * are specified, all attachments will be added to the feature(s).
52
50
  */
53
51
  blobs: File | File[];
54
52
  }
@@ -119,10 +117,10 @@ export interface EditOptions {
119
117
  */
120
118
  editGeometryOptions?: EditGeometryOptions;
121
119
  /**
122
- * Web only. Additional settings that are specific to sketching plugins,
123
- * keyed by plugin ID. The only currently supported plugin is "snapping". A
124
- * boolean value can also be assigned to completely disable, or enable with
125
- * default settings.
120
+ * Additional settings that are specific to sketching plugins, keyed by
121
+ * plugin ID. The only currently supported plugin is "snapping". A boolean
122
+ * value can also be assigned to completely disable, or enable with default
123
+ * settings.
126
124
  */
127
125
  pluginSettings?: Record<string, boolean | Record<string, unknown>>;
128
126
  }
@@ -137,8 +135,8 @@ export interface UpdateSessionArgs extends HasGeometry {
137
135
  */
138
136
  attributes?: Record<string, string | number>;
139
137
  /**
140
- * A collection of attachments that apply or are to be applied to the
141
- * currently edited feature.
138
+ * An array of attachments that apply or are to be applied to the currently
139
+ * edited feature.
142
140
  */
143
141
  attachments?: Attachment[];
144
142
  }
@@ -248,7 +246,7 @@ export interface ValidationResult {
248
246
  */
249
247
  isValid: boolean;
250
248
  /**
251
- * Optional validation message or error details.
249
+ * Validation message or error details.
252
250
  */
253
251
  message?: string;
254
252
  }
@@ -271,7 +269,7 @@ export interface BulkAttributeCompleteEventArgs extends HasFeatures {
271
269
  */
272
270
  success: boolean;
273
271
  /**
274
- * Optional error message if the update failed.
272
+ * Error message if the update failed.
275
273
  */
276
274
  error?: string;
277
275
  }
@@ -306,7 +304,7 @@ export declare class EditCommands extends CommandRegistry {
306
304
  get addFeature(): Command<Feature | Features | EditCommandArgs>;
307
305
  /**
308
306
  * Cancels active editing sessions and discards any changes. If a feature is
309
- * supplied only the sessions using that feature will be cancelled. Web
307
+ * supplied, only the sessions using that feature will be cancelled. Web
310
308
  * only.
311
309
  *
312
310
  * @webOnly
@@ -315,7 +313,7 @@ export declare class EditCommands extends CommandRegistry {
315
313
  /**
316
314
  * Completes active editing sessions and submits any changes made to the
317
315
  * attributes, attachments or geometry to the feature source. If a feature
318
- * is supplied, only sessions using that feature will close. Web only.
316
+ * is supplied, only sessions using that feature will complete. Web only.
319
317
  *
320
318
  * @webOnly
321
319
  */
@@ -333,9 +331,10 @@ export declare class EditCommands extends CommandRegistry {
333
331
  * initial attributes collection. If no geometry is provided in context they
334
332
  * will be asked to select one.
335
333
  *
336
- * _Note:_ $map1.map.extension is the output of a 'Get Map' activity run in
337
- * Web by Workflow. When the map and/or layer are provided in the context of
338
- * a command chain these parameters can be omitted.
334
+ * _Note:_ "maps" argument can be the output of a 'Get Map' activity run in
335
+ * Web by Workflow or coming from a previous operation in the action chain.
336
+ * When the map and/or layer are provided in the context of a command chain
337
+ * these parameters can be omitted.
339
338
  *
340
339
  * ```
341
340
  * {
@@ -344,8 +343,7 @@ export declare class EditCommands extends CommandRegistry {
344
343
  * "featureAttributes": {
345
344
  * "ASSET_ID": "WFH001234"
346
345
  * },
347
- * "layers": "Victoria_Fire_Hydrants_8780",
348
- * "maps": $map1.map.extension
346
+ * "layers": "Victoria_Fire_Hydrants_8780"
349
347
  * }
350
348
  * ```
351
349
  */
@@ -365,8 +363,8 @@ export declare class EditCommands extends CommandRegistry {
365
363
  * ad-hoc feature created from a JSON object. For example, you can use
366
364
  * the output of `results.get-active-features`, or the feature provided
367
365
  * in a command chain context.
368
- * 2. `editableExpression` and `requiredExpression` both take an arcade
369
- * expression, and here the string "true" is just a simple arcade
366
+ * 2. `editableExpression` and `requiredExpression` both take an Arcade
367
+ * expression, and here the string "true" is just a simple Arcade
370
368
  * expression that always returns true. You can also use a more complex
371
369
  * expression, or reference one from your webmap.
372
370
  *
@@ -374,7 +372,6 @@ export declare class EditCommands extends CommandRegistry {
374
372
  * {
375
373
  * "editAttributes": true,
376
374
  * "editAttachments": true,
377
- * "features": $runOperation1.result,
378
375
  * "relationshipId": "1",
379
376
  * "fieldElements": [
380
377
  * {
@@ -417,6 +414,7 @@ export declare class EditCommands extends CommandRegistry {
417
414
  /**
418
415
  * Clears a feature's GNSS metadata. This command will clear the well known
419
416
  * GNSS attributes, such as "esrignss_longitude" and "esrignss_latitude".
417
+ * Mobile only.
420
418
  *
421
419
  * @mobileOnly
422
420
  */
@@ -437,7 +435,7 @@ export declare class EditOperations extends OperationRegistry {
437
435
  * location data. Examples of well known GNSS attributes are
438
436
  * "esrignss_longitude" and "esrignss_latitude". The input feature argument
439
437
  * may be null, in which case a new feature will be created. Returns the
440
- * input feature, or a new feature if one was created.
438
+ * input feature, or a new feature if one was created. Mobile only.
441
439
  *
442
440
  * @mobileOnly
443
441
  */
@@ -27,7 +27,7 @@ export interface PickFileArgs {
27
27
  */
28
28
  attachmentType: AttachmentType;
29
29
  /**
30
- * Allowed types of file used to pick a file. Mobile only.
30
+ * Allowed file types used to pick a file. Mobile only.
31
31
  *
32
32
  * @mobileOnly
33
33
  */
@@ -68,8 +68,8 @@ export interface FileDownloadInfo {
68
68
  */
69
69
  export interface FileDownloadStartedEventArgs {
70
70
  /**
71
- * The collection of FileDownloadInfos describing the file downloads that
72
- * have started.
71
+ * The list of FileDownloadInfos describing the file downloads that have
72
+ * started.
73
73
  */
74
74
  fileDownloadInfos: FileDownloadInfo[];
75
75
  }
@@ -31,29 +31,98 @@ export interface GeolocateMetadataChangedEventArgs {
31
31
  */
32
32
  nmeaProperties: NmeaProperties;
33
33
  }
34
+ /**
35
+ * Properties describing a GNSS data point.
36
+ */
34
37
  export interface NmeaProperties {
38
+ /**
39
+ * A timestamp of when the location was recorded.
40
+ */
35
41
  fixTimeUtc?: Date;
42
+ /**
43
+ * The latitude (y-value).
44
+ */
36
45
  latitude?: number;
46
+ /**
47
+ * The longitude (x-value).
48
+ */
37
49
  longitude?: number;
50
+ /**
51
+ * The altitude (z-value).
52
+ */
38
53
  altitude?: number;
54
+ /**
55
+ * Horizontal Dilution of Precision (measure of accuracy in 2-D position;
56
+ * for example, Latitude and Longitude), 0.5 through 99.9 in percents.
57
+ */
39
58
  horizontalDilutionOfPrecision?: number;
59
+ /**
60
+ * Vertical Dilution of Precision (measure of accuracy in 1-D position), 0.5
61
+ * through 99.9 in percents.
62
+ */
40
63
  verticalDilutionOfPrecision?: number;
64
+ /**
65
+ * Gets the Position Dilution of Precision (measure of accuracy in 3-d
66
+ * position), 0.5 through 99.9 in percents.
67
+ */
41
68
  positionDilutionOfPrecision?: number;
42
- estimatedVerticalAccuracy?: number;
43
- preciseVerticalAccuracy?: number;
44
- estimatedHorizontalAccuracy?: number;
45
- preciseHorizontalAccuracy?: number;
69
+ /**
70
+ * Estimated vertical accuracy of this location in meters.
71
+ */
72
+ verticalAccuracy?: number;
73
+ /**
74
+ * Estimated horizontal accuracy of this location in meters.
75
+ */
76
+ horizontalAccuracy?: number;
77
+ /**
78
+ * The number of satellites in view.
79
+ */
46
80
  satellitesInView?: number;
81
+ /**
82
+ * The number of satellites used in the calculation of the location.
83
+ */
47
84
  satellitesInUse?: number;
85
+ /**
86
+ * The ids of the satellites in view.
87
+ */
48
88
  satelliteIds?: number[];
89
+ /**
90
+ * The geoidal separation, the height difference between ellipsoidal surface
91
+ * and the geoid model's surface in meters.
92
+ */
49
93
  heightOfGeoid?: number;
94
+ /**
95
+ * The age of differential GPS data record; TimeSpan.Zero when DGPS is not
96
+ * used.
97
+ */
50
98
  correctionAge?: TimeSpan;
99
+ /**
100
+ * The reference station ID, range from 0000-4095.
101
+ */
51
102
  stationId?: number;
103
+ /**
104
+ * The velocity of the device, in meters per second.
105
+ */
52
106
  speed?: number;
107
+ /**
108
+ * The course of the device, in degrees.
109
+ */
53
110
  course?: number;
111
+ /**
112
+ * The magnetic variation, in degrees.
113
+ *
114
+ * Positive values (easterly variation) subtract from the true course and
115
+ * negative values (westerly variation) add to the true course.
116
+ */
54
117
  magneticVariation?: number;
55
- fixQuality?: FixQuality;
56
- fixMethod?: string;
118
+ /**
119
+ * Gets the NMEA type of signal or technique being used by the GPS receiver
120
+ * to determine its location.
121
+ */
122
+ fixType?: string;
123
+ /**
124
+ * Whether this is a 2D or 3D fix.
125
+ */
57
126
  fixMode?: GnssFixMode;
58
127
  }
59
128
  /**
@@ -88,7 +157,7 @@ export interface GeolocateCurrentState {
88
157
  */
89
158
  export interface GeolocationStatusChangedEventArgs {
90
159
  /**
91
- * Indicates whether the geolocation is now enabled.
160
+ * Indicates whether the geolocation is enabled.
92
161
  */
93
162
  isEnabled: boolean;
94
163
  }
@@ -156,7 +225,8 @@ export interface SetLocationSymbolArgs {
156
225
  */
157
226
  outline?: SimpleLineSymbol;
158
227
  /**
159
- * The size to use for the location marker.
228
+ * The size to use for the location marker, in device independent pixels
229
+ * (DIPs).
160
230
  */
161
231
  size?: number;
162
232
  /**
@@ -268,7 +338,8 @@ export type GnssLockStatus =
268
338
  */
269
339
  export interface GnssDeviceAntennaHeightEventArgs {
270
340
  /**
271
- * The antenna height.
341
+ * The antenna height. May be either feet or meters depending on user
342
+ * setting.
272
343
  */
273
344
  height: number;
274
345
  }
@@ -1,9 +1,5 @@
1
- import type { FeatureSet } from "@vertigis/arcgis-extensions/data/FeatureSet";
2
- import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
3
1
  import type { Command } from "../Command.js";
4
2
  import { CommandRegistry } from "../CommandRegistry.js";
5
- import type { Operation } from "../Operation.js";
6
- import { OperationRegistry } from "../OperationRegistry.js";
7
3
  import type { Features, HasMaps, HasMapsAndFeatures, Maps } from "../common.js";
8
4
  export declare class HighlightsCommands extends CommandRegistry {
9
5
  protected readonly _prefix = "highlights";
@@ -69,18 +65,3 @@ export declare class HighlightsCommands extends CommandRegistry {
69
65
  */
70
66
  get showFocus(): Command<HasMaps>;
71
67
  }
72
- export declare class HighlightsOperations extends OperationRegistry {
73
- protected readonly _prefix = "highlights";
74
- /**
75
- * Returns all highlighted features for a given map. Web only.
76
- *
77
- * @webOnly
78
- */
79
- get get(): Operation<MapExtension, FeatureSet>;
80
- /**
81
- * Returns all focused features for a given map. Web only.
82
- *
83
- * @webOnly
84
- */
85
- get getFocused(): Operation<MapExtension, FeatureSet>;
86
- }
@@ -1 +1 @@
1
- import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class HighlightsCommands extends e{_prefix="highlights";get add(){return this._get("add")}get remove(){return this._get("remove")}get clear(){return this._get("clear")}get pulse(){return this._get("pulse")}get addFocus(){return this._get("add-focus")}get removeFocus(){return this._get("remove-focus")}get clearFocus(){return this._get("clear-focus")}get hide(){return this._get("hide")}get hideFocus(){return this._get("hide-focus")}get refresh(){return this._get("refresh")}get show(){return this._get("show")}get showFocus(){return this._get("show-focus")}}export class HighlightsOperations extends t{_prefix="highlights";get get(){return this._get("get")}get getFocused(){return this._get("get-focused")}}
1
+ import{CommandRegistry as e}from"../CommandRegistry.js";export class HighlightsCommands extends e{_prefix="highlights";get add(){return this._get("add")}get remove(){return this._get("remove")}get clear(){return this._get("clear")}get pulse(){return this._get("pulse")}get addFocus(){return this._get("add-focus")}get removeFocus(){return this._get("remove-focus")}get clearFocus(){return this._get("clear-focus")}get hide(){return this._get("hide")}get hideFocus(){return this._get("hide-focus")}get refresh(){return this._get("refresh")}get show(){return this._get("show")}get showFocus(){return this._get("show-focus")}}
@@ -14,7 +14,7 @@ import type { HasFiles, HasLayers, HasMaps, HasRenderer, HasSymbol, HasSymbols,
14
14
  */
15
15
  export interface LayerEventArgs {
16
16
  /**
17
- * The layer whose visibility was changed. Web only.
17
+ * The layer(s) whose visibility was changed. Web only.
18
18
  *
19
19
  * @webOnly
20
20
  */
@@ -1,3 +1,4 @@
1
+ import type { Thickness } from "../DotNetTypes.js";
1
2
  import type { Event } from "../Event.js";
2
3
  import { EventRegistry } from "../EventRegistry.js";
3
4
  /**
@@ -5,11 +6,6 @@ import { EventRegistry } from "../EventRegistry.js";
5
6
  */
6
7
  export interface Page {
7
8
  }
8
- /**
9
- * The margin thickness.
10
- */
11
- export interface Thickness {
12
- }
13
9
  /**
14
10
  * Arguments for the "layout.margin-changed" event.
15
11
  */
@@ -11,11 +11,11 @@ export declare class LicenseRequestArgs {
11
11
  */
12
12
  applicationName?: string;
13
13
  /**
14
- * The accountId (orgId) that we want to check licensing.
14
+ * The accountId (orgId) that we want to check licensing for.
15
15
  */
16
16
  accountId?: string;
17
17
  /**
18
- * Overwrite the SKU for license check.
18
+ * Overwrite the default SKU (if any) for license checking.
19
19
  */
20
20
  sku?: string;
21
21
  }
@@ -11,7 +11,7 @@ import type { Event } from "../Event.js";
11
11
  import { EventRegistry } from "../EventRegistry.js";
12
12
  import type { MapsLike, ModelRef } from "../common.js";
13
13
  /**
14
- * An object that has a `maps property.
14
+ * An object that has a `maps` property.
15
15
  */
16
16
  export interface HasMapsRef {
17
17
  /**
@@ -170,7 +170,6 @@ export declare class LocationMarkerCommands extends CommandRegistry {
170
170
  * {
171
171
  * "color": [24, 128, 255, 255],
172
172
  * "fov": 120,
173
- * "geometry": $geometry1.geometry,
174
173
  * "heading": 60,
175
174
  * "id": "custom-marker-1",
176
175
  * "symbol": "dot",