@vertigis/viewer-spec 50.5.0 → 50.5.1
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.
- package/README.md +1 -1
- package/analytics/AnalyticsContext.d.ts +2 -1
- package/analytics/CommonAction.d.ts +2 -1
- package/analytics/MobileAction.d.ts +6 -3
- package/app-config/AppConfig.d.ts +11 -8
- package/app-config/common/BrandingThemeProperties.d.ts +4 -2
- package/app-config/common/HighlightModelProperties.d.ts +4 -2
- package/app-config/common/LayerPresetsModelProperties.d.ts +2 -1
- package/app-config/common/LicensingModelProperties.d.ts +1 -1
- package/app-config/common/ResultsModelProperties.d.ts +2 -1
- package/app-config/common/TranslatableText.d.ts +2 -1
- package/app-config/common/WorkflowModelProperties.d.ts +4 -2
- package/app-config/mobile/FeatureDetailsModelProperties.d.ts +4 -2
- package/app-config/mobile/VertigisMobileModelProperties.d.ts +4 -3
- package/app-config/schema/common-app-config.schema.json +1 -1
- package/app-config/schema/mobile-app-config.schema.json +1 -1
- package/app-config/schema/web-app-config.schema.json +1 -1
- package/app-config/web/CoordinateModelProperties.d.ts +2 -1
- package/app-config/web/DrawModelProperties.d.ts +2 -1
- package/app-config/web/HasVisibilityFilters.d.ts +2 -1
- package/app-config/web/KpiCardModelProperties.d.ts +2 -1
- package/app-config/web/MapCoordinatesModelProperties.d.ts +2 -1
- package/app-config/web/MapModelProperties.d.ts +4 -2
- package/app-config/web/MeasurementModelProperties.d.ts +2 -1
- package/app-config/web/PortalModelProperties.d.ts +2 -1
- package/app-config/web/ResultsModelProperties.d.ts +4 -2
- package/app-config/web/SearchModelProperties.d.ts +2 -1
- package/app-config/web/VertigisWebModelProperties.d.ts +6 -3
- package/docs/Geocortex Apps.md +8 -8
- package/docs/layout-spec.md +105 -94
- package/layout/schema/layout-common.xsd +1 -1
- package/layout/schema/layout-web.xsd +1 -1
- package/messaging/Command.d.ts +4 -2
- package/messaging/Event.d.ts +4 -2
- package/messaging/Message.d.ts +2 -1
- package/messaging/Operation.d.ts +4 -2
- package/messaging/common.d.ts +12 -6
- package/messaging/registry/app.d.ts +12 -6
- package/messaging/registry/arcade.d.ts +6 -3
- package/messaging/registry/auth.d.ts +12 -7
- package/messaging/registry/basemap.d.ts +2 -1
- package/messaging/registry/drawing.d.ts +8 -4
- package/messaging/registry/edit.d.ts +6 -3
- package/messaging/registry/file.d.ts +2 -1
- package/messaging/registry/geocode.d.ts +8 -5
- package/messaging/registry/geolocation.d.ts +20 -11
- package/messaging/registry/geometry.d.ts +10 -5
- package/messaging/registry/kpi.d.ts +4 -2
- package/messaging/registry/layout.d.ts +2 -1
- package/messaging/registry/location-marker.d.ts +10 -5
- package/messaging/registry/map.d.ts +15 -8
- package/messaging/registry/measurement.d.ts +4 -2
- package/messaging/registry/messaging.d.ts +1 -1
- package/messaging/registry/offline.d.ts +16 -9
- package/messaging/registry/panel.d.ts +2 -1
- package/messaging/registry/portal.d.ts +8 -4
- package/messaging/registry/printing.d.ts +4 -2
- package/messaging/registry/results.d.ts +19 -10
- package/messaging/registry/settings.d.ts +4 -2
- package/messaging/registry/sketching.d.ts +38 -26
- package/messaging/registry/tasks.d.ts +7 -4
- package/messaging/registry/ui.d.ts +14 -7
- package/messaging/registry/viewer.d.ts +2 -1
- package/messaging/registry/workflow.d.ts +6 -3
- package/messaging/schema/common-action.schema.json +269 -236
- package/messaging/schema/common-event.schema.json +118 -122
- package/messaging/schema/mobile-action.schema.json +266 -233
- package/messaging/schema/mobile-event.schema.json +146 -153
- package/messaging/schema/web-action.schema.json +305 -269
- package/messaging/schema/web-event.schema.json +144 -151
- package/package.json +17 -17
- package/version.d.ts +2 -2
- package/version.js +2 -2
package/messaging/common.d.ts
CHANGED
|
@@ -46,7 +46,8 @@ export interface Model extends Entity {
|
|
|
46
46
|
*/
|
|
47
47
|
export declare type ModelRef = string | Model;
|
|
48
48
|
/**
|
|
49
|
-
* Result of the "drawing.create-graphics" and "measurement.create-graphics"
|
|
49
|
+
* Result of the "drawing.create-graphics" and "measurement.create-graphics"
|
|
50
|
+
* operations.
|
|
50
51
|
*/
|
|
51
52
|
export interface CreateGraphicsResult {
|
|
52
53
|
/**
|
|
@@ -147,7 +148,8 @@ export interface HasMaps {
|
|
|
147
148
|
*/
|
|
148
149
|
export declare type Maps = MapsLike | HasMaps;
|
|
149
150
|
/**
|
|
150
|
-
* A reference to an existing layer, which is the ID or title of the layer (or
|
|
151
|
+
* A reference to an existing layer, which is the ID or title of the layer (or
|
|
152
|
+
* both).
|
|
151
153
|
*/
|
|
152
154
|
export declare type LayerReference = string | LayerReferenceObject;
|
|
153
155
|
/**
|
|
@@ -168,7 +170,8 @@ export interface HasLayers {
|
|
|
168
170
|
layers?: LayersLike;
|
|
169
171
|
}
|
|
170
172
|
/**
|
|
171
|
-
* One or more layer extensions, or an object that has one or more layer
|
|
173
|
+
* One or more layer extensions, or an object that has one or more layer
|
|
174
|
+
* extensions.
|
|
172
175
|
*/
|
|
173
176
|
export declare type Layers = LayersLike | HasLayers;
|
|
174
177
|
/**
|
|
@@ -193,7 +196,8 @@ export interface HasGraphics {
|
|
|
193
196
|
graphics?: GraphicsLike;
|
|
194
197
|
}
|
|
195
198
|
/**
|
|
196
|
-
* An object with arguments for a command or operation that can display
|
|
199
|
+
* An object with arguments for a command or operation that can display
|
|
200
|
+
* temporary UI.
|
|
197
201
|
*/
|
|
198
202
|
export interface HasUITarget {
|
|
199
203
|
/**
|
|
@@ -261,7 +265,8 @@ export interface HasSymbol {
|
|
|
261
265
|
symbol?: SymbolLike;
|
|
262
266
|
}
|
|
263
267
|
/**
|
|
264
|
-
* An object that is convertible to an Esri Viewpoint, or that has a viewpoint
|
|
268
|
+
* An object that is convertible to an Esri Viewpoint, or that has a viewpoint
|
|
269
|
+
* property.
|
|
265
270
|
*/
|
|
266
271
|
export declare type ViewpointArg = ViewpointLike | HasViewPoint;
|
|
267
272
|
/**
|
|
@@ -291,7 +296,8 @@ export interface Blob {
|
|
|
291
296
|
* _not_ be included in the new Blob (i.e. the byte exactly at this index
|
|
292
297
|
* is not included).
|
|
293
298
|
* @param contentType The content type to assign to the new Blob; this will
|
|
294
|
-
* be the value of its type property. The default value is an empty
|
|
299
|
+
* be the value of its type property. The default value is an empty
|
|
300
|
+
* string.
|
|
295
301
|
*/
|
|
296
302
|
slice(start?: number, end?: number, contentType?: string): Blob;
|
|
297
303
|
/**
|
|
@@ -13,7 +13,8 @@ import type { Blob } from "../common.js";
|
|
|
13
13
|
export interface GcxAppInfo {
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* Arguments for the app started events. Only available in VertiGIS Studio
|
|
16
|
+
* Arguments for the app started events. Only available in VertiGIS Studio
|
|
17
|
+
* Mobile.
|
|
17
18
|
*/
|
|
18
19
|
export interface SpecificAppArgs {
|
|
19
20
|
/**
|
|
@@ -54,13 +55,15 @@ export interface GenericAppsListedArgs {
|
|
|
54
55
|
export declare class AppCommands extends CommandRegistry {
|
|
55
56
|
/**
|
|
56
57
|
* Returns to the app selector view where the user can select a different
|
|
57
|
-
* app. Only enabled if the current app was launched through VertiGIS Studio
|
|
58
|
+
* app. Only enabled if the current app was launched through VertiGIS Studio
|
|
59
|
+
* Go.
|
|
58
60
|
*
|
|
59
61
|
* @mobileOnly
|
|
60
62
|
*/
|
|
61
63
|
get goToAppSelector(): Command;
|
|
62
64
|
/**
|
|
63
|
-
* Refreshes the currently loaded app so that it can download updates if
|
|
65
|
+
* Refreshes the currently loaded app so that it can download updates if
|
|
66
|
+
* available.
|
|
64
67
|
*
|
|
65
68
|
* @mobileOnly
|
|
66
69
|
*/
|
|
@@ -91,7 +94,8 @@ export declare class AppCommands extends CommandRegistry {
|
|
|
91
94
|
get unfavorite(): Command;
|
|
92
95
|
/**
|
|
93
96
|
* 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
|
|
97
|
+
* accordingly. If more than one file is provided, only the first will be
|
|
98
|
+
* loaded.
|
|
95
99
|
*
|
|
96
100
|
* @webOnly
|
|
97
101
|
*/
|
|
@@ -195,7 +199,8 @@ export declare class AppOperations extends OperationRegistry {
|
|
|
195
199
|
*/
|
|
196
200
|
get getVersion(): Operation<void, string>;
|
|
197
201
|
/**
|
|
198
|
-
* Creates app config for a project, based on the current state of the
|
|
202
|
+
* Creates app config for a project, based on the current state of the
|
|
203
|
+
* application.
|
|
199
204
|
*
|
|
200
205
|
* @webOnly
|
|
201
206
|
*/
|
|
@@ -235,7 +240,8 @@ declare enum StorageScope {
|
|
|
235
240
|
*/
|
|
236
241
|
GLOBAL = "global",
|
|
237
242
|
/**
|
|
238
|
-
* Defines the app specific storage that only is accessible from within the
|
|
243
|
+
* Defines the app specific storage that only is accessible from within the
|
|
244
|
+
* very app.
|
|
239
245
|
*/
|
|
240
246
|
APP = "app",
|
|
241
247
|
/**
|
|
@@ -21,7 +21,8 @@ export interface RunArcadeArgs {
|
|
|
21
21
|
canExecuteScript?: string;
|
|
22
22
|
/**
|
|
23
23
|
* An arguments object that provides named variables and associated values,
|
|
24
|
-
* which can be referenced from within the executeScript and
|
|
24
|
+
* which can be referenced from within the executeScript and
|
|
25
|
+
* canExecuteScript.
|
|
25
26
|
*
|
|
26
27
|
* NOTE: All variable keys must consist of only lowercase letters;
|
|
27
28
|
* camel-cased context variables will break the script when they are
|
|
@@ -63,7 +64,8 @@ export declare class ArcadeOperations extends OperationRegistry {
|
|
|
63
64
|
get run(): Operation<RunArcadeArgs | string, unknown>;
|
|
64
65
|
}
|
|
65
66
|
/**
|
|
66
|
-
* Properties used to set a series of watch handles and/or event listeners on an
|
|
67
|
+
* Properties used to set a series of watch handles and/or event listeners on an
|
|
68
|
+
* item.
|
|
67
69
|
*/
|
|
68
70
|
export interface WatchEventHandleProperties {
|
|
69
71
|
/**
|
|
@@ -74,7 +76,8 @@ export interface WatchEventHandleProperties {
|
|
|
74
76
|
* One or more properties on the item that will be watched for changes
|
|
75
77
|
* and/or events. Any strings will be used as propertyPaths that will be
|
|
76
78
|
* watched for changes; for this to work, the item and all properties
|
|
77
|
-
* referenced within the path (except for the last) must implement
|
|
79
|
+
* referenced within the path (except for the last) must implement
|
|
80
|
+
* {@link Observable}.
|
|
78
81
|
*/
|
|
79
82
|
watch: string | WatchEventProperty | (string | WatchEventProperty)[];
|
|
80
83
|
}
|
|
@@ -23,12 +23,14 @@ export declare enum AuthenticationType {
|
|
|
23
23
|
*/
|
|
24
24
|
export interface Principal {
|
|
25
25
|
/**
|
|
26
|
-
* The ArcGIS JavaScript API PortalUser object containing information about
|
|
26
|
+
* The ArcGIS JavaScript API PortalUser object containing information about
|
|
27
|
+
* the user.
|
|
27
28
|
*/
|
|
28
29
|
portalUser: PortalUser;
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
|
-
* Arguments for the auth.sign-in events. Only available in VertiGIS Studio
|
|
32
|
+
* Arguments for the auth.sign-in events. Only available in VertiGIS Studio
|
|
33
|
+
* Mobile.
|
|
32
34
|
*/
|
|
33
35
|
export interface SignInEventArgs {
|
|
34
36
|
/**
|
|
@@ -69,8 +71,8 @@ export interface SignInCompletedEventArgs {
|
|
|
69
71
|
identity: ArcGISPortalIdentity;
|
|
70
72
|
}
|
|
71
73
|
/**
|
|
72
|
-
* Arguments for the auth.sign-in-failed event. Only available in the
|
|
73
|
-
* Mobile Viewer.
|
|
74
|
+
* Arguments for the auth.sign-in-failed event. Only available in the VertiGIS
|
|
75
|
+
* Studio Mobile Viewer.
|
|
74
76
|
*/
|
|
75
77
|
export interface SignInFailedEventArgs extends SignInEventArgs {
|
|
76
78
|
/**
|
|
@@ -83,7 +85,8 @@ export declare class AuthCommands extends CommandRegistry {
|
|
|
83
85
|
/**
|
|
84
86
|
* Initiates user sign-in if they aren't already signed in. The argument
|
|
85
87
|
* indicates whether or not the map should be reloaded when the sign-in is
|
|
86
|
-
* complete. This argument is optional and only supported by VertiGIS Studio
|
|
88
|
+
* complete. This argument is optional and only supported by VertiGIS Studio
|
|
89
|
+
* Mobile.
|
|
87
90
|
*/
|
|
88
91
|
get signIn(): Command<boolean | void>;
|
|
89
92
|
/**
|
|
@@ -125,7 +128,8 @@ export declare class AuthEvents extends EventRegistry {
|
|
|
125
128
|
*/
|
|
126
129
|
get signInCompleted(): Event<Principal | SignInCompletedEventArgs>;
|
|
127
130
|
/**
|
|
128
|
-
* Raised when the user has signed into a Portal (AGOL or Portal for
|
|
131
|
+
* Raised when the user has signed into a Portal (AGOL or Portal for
|
|
132
|
+
* ArcGIS).
|
|
129
133
|
*
|
|
130
134
|
* @mobileOnly
|
|
131
135
|
*/
|
|
@@ -148,7 +152,8 @@ export declare class AuthEvents extends EventRegistry {
|
|
|
148
152
|
get signOutRequested(): Event;
|
|
149
153
|
/**
|
|
150
154
|
* Raised when the user's token is refreshed. Will be the new token in the
|
|
151
|
-
* VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio
|
|
155
|
+
* VertiGIS Studio Web, and a TokenCredential object in VertiGIS Studio
|
|
156
|
+
* Mobile.
|
|
152
157
|
*/
|
|
153
158
|
get tokenRefreshed(): Event<string>;
|
|
154
159
|
}
|
|
@@ -20,7 +20,8 @@ export declare class BasemapOperations extends OperationRegistry {
|
|
|
20
20
|
* Having argument:
|
|
21
21
|
*
|
|
22
22
|
* - Multiple maps: the union of all basemap options from each
|
|
23
|
-
* - No maps: the union of all basemap options for every map in the
|
|
23
|
+
* - No maps: the union of all basemap options for every map in the
|
|
24
|
+
* application.
|
|
24
25
|
*/
|
|
25
26
|
get getAll(): Operation<MapsLike, BasemapExtension[]>;
|
|
26
27
|
/**
|
|
@@ -29,7 +29,8 @@ import type { CaptureGeometryArgs } from "./sketching.js";
|
|
|
29
29
|
*/
|
|
30
30
|
export declare type DrawingSymbolConfig = SimpleMarkerSymbol | SimpleMarkerSymbolProperties | PictureMarkerSymbol | PictureMarkerSymbolProperties | SimpleLineSymbol | SimpleLineSymbolProperties | SimpleFillSymbol | SimpleFillSymbolProperties | PictureFillSymbol | PictureFillSymbolProperties | PointSymbol3D | PointSymbol3DProperties | LineSymbol3D | LineSymbol3DProperties | PolygonSymbol3D | PolygonSymbol3DProperties;
|
|
31
31
|
/**
|
|
32
|
-
* Arguments for the drawing.get-symbol operation. Only available in
|
|
32
|
+
* Arguments for the drawing.get-symbol operation. Only available in VertiGIS
|
|
33
|
+
* Studio Web.
|
|
33
34
|
*/
|
|
34
35
|
export interface GetDefaultSymbolArgs {
|
|
35
36
|
/**
|
|
@@ -38,7 +39,8 @@ export interface GetDefaultSymbolArgs {
|
|
|
38
39
|
geometryType?: GeometryType;
|
|
39
40
|
}
|
|
40
41
|
/**
|
|
41
|
-
* Arguments for the drawing.edit-symbol operation. Only available in
|
|
42
|
+
* Arguments for the drawing.edit-symbol operation. Only available in VertiGIS
|
|
43
|
+
* Studio Web.
|
|
42
44
|
*/
|
|
43
45
|
export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeatures, HasUITarget {
|
|
44
46
|
/**
|
|
@@ -64,7 +66,8 @@ export interface EditSymbolArgs extends HasMaps, HasLayers, HasGraphics, HasFeat
|
|
|
64
66
|
showOnlySymbolPresets?: boolean;
|
|
65
67
|
}
|
|
66
68
|
/**
|
|
67
|
-
* Arguments for the drawing.edit-symbol operation. Only available in
|
|
69
|
+
* Arguments for the drawing.edit-symbol operation. Only available in VertiGIS
|
|
70
|
+
* Studio Web.
|
|
68
71
|
*/
|
|
69
72
|
export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFeatures {
|
|
70
73
|
/**
|
|
@@ -73,7 +76,8 @@ export interface EditSymbolResult extends HasMaps, HasLayers, HasGraphics, HasFe
|
|
|
73
76
|
symbol: Symbol;
|
|
74
77
|
}
|
|
75
78
|
/**
|
|
76
|
-
* Arguments for the "drawing.create-graphics" operation. Only available in
|
|
79
|
+
* Arguments for the "drawing.create-graphics" operation. Only available in
|
|
80
|
+
* Mobile.
|
|
77
81
|
*/
|
|
78
82
|
export interface CreateGraphicsArgs {
|
|
79
83
|
/**
|
|
@@ -10,7 +10,8 @@ import { OperationRegistry } from "../OperationRegistry.js";
|
|
|
10
10
|
import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
|
|
11
11
|
import type { EditGeometryOptions } from "./sketching.js";
|
|
12
12
|
/**
|
|
13
|
-
* Arguments for the "edit.add-attachment" command. Supported by both Web and
|
|
13
|
+
* Arguments for the "edit.add-attachment" command. Supported by both Web and
|
|
14
|
+
* Mobile.
|
|
14
15
|
*/
|
|
15
16
|
export interface AddAttachmentArgs {
|
|
16
17
|
/**
|
|
@@ -61,7 +62,8 @@ export interface DeleteAttachmentArgs {
|
|
|
61
62
|
/**
|
|
62
63
|
* The attachment(s) to remove from the feature(s). This property can be
|
|
63
64
|
* populated with the title(s) or ID(s) of the attachments(s). Any and all
|
|
64
|
-
* matching attachments found on the input features will be deleted. Web
|
|
65
|
+
* matching attachments found on the input features will be deleted. Web
|
|
66
|
+
* only.
|
|
65
67
|
*/
|
|
66
68
|
attachments?: string[];
|
|
67
69
|
/**
|
|
@@ -100,7 +102,8 @@ export interface EditUIOptions {
|
|
|
100
102
|
showTitles?: boolean;
|
|
101
103
|
}
|
|
102
104
|
/**
|
|
103
|
-
* A collection of options common to interactive feature editing sessions. Web
|
|
105
|
+
* A collection of options common to interactive feature editing sessions. Web
|
|
106
|
+
* only.
|
|
104
107
|
*/
|
|
105
108
|
export interface EditOptions {
|
|
106
109
|
/**
|
|
@@ -58,7 +58,8 @@ export interface FileDownloadInfo {
|
|
|
58
58
|
filePath: string;
|
|
59
59
|
/**
|
|
60
60
|
* A value indicating whether this download is updating a file. If true, it
|
|
61
|
-
* means that the file already existed on disk and a new version is being
|
|
61
|
+
* means that the file already existed on disk and a new version is being
|
|
62
|
+
* downloaded.
|
|
62
63
|
*/
|
|
63
64
|
isUpdating: boolean;
|
|
64
65
|
}
|
|
@@ -1,7 +1,10 @@
|
|
|
1
1
|
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
2
|
+
import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
|
|
3
|
+
import type { CountResult } from "@vertigis/arcgis-extensions/tasks/CountResult.js";
|
|
2
4
|
import type { AddressLike, GeocodeOptions } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
|
|
3
5
|
import type { Operation } from "../Operation.js";
|
|
4
6
|
import { OperationRegistry } from "../OperationRegistry.js";
|
|
7
|
+
import type { Features } from "../common.js";
|
|
5
8
|
/**
|
|
6
9
|
* Arguments for the "geocode.geocode" and "geocode.count" operations.
|
|
7
10
|
*/
|
|
@@ -58,26 +61,26 @@ export declare class GeocodeOperations extends OperationRegistry {
|
|
|
58
61
|
/**
|
|
59
62
|
* Finds one or more locations corresponding to an address.
|
|
60
63
|
*/
|
|
61
|
-
get geocode(): Operation<GeocodeArgs>;
|
|
64
|
+
get geocode(): Operation<GeocodeArgs, Features>;
|
|
62
65
|
/**
|
|
63
66
|
* Finds locations corresponding to multiple addresses. The geocoder must
|
|
64
67
|
* have the supportsBatchGeocoding capability.
|
|
65
68
|
*
|
|
66
69
|
* @webOnly
|
|
67
70
|
*/
|
|
68
|
-
get batchGeocode(): Operation<BatchGeocodeArgs>;
|
|
71
|
+
get batchGeocode(): Operation<BatchGeocodeArgs, Features>;
|
|
69
72
|
/**
|
|
70
73
|
* Counts the number of locations corresponding to an address.
|
|
71
74
|
*/
|
|
72
|
-
get count(): Operation<GeocodeArgs>;
|
|
75
|
+
get count(): Operation<GeocodeArgs, CountResult>;
|
|
73
76
|
/**
|
|
74
77
|
* Suggests matching addresses to search for based on some input text. The
|
|
75
78
|
* geocoder must have the supportsSuggest capability.
|
|
76
79
|
*/
|
|
77
|
-
get suggest(): Operation<SuggestArgs>;
|
|
80
|
+
get suggest(): Operation<SuggestArgs, string[]>;
|
|
78
81
|
/**
|
|
79
82
|
* Finds the address at a particular location. The geocoder must have the
|
|
80
83
|
* supportsReverseGeocoding capability.
|
|
81
84
|
*/
|
|
82
|
-
get reverseGeocode(): Operation<ReverseGeocodeArgs>;
|
|
85
|
+
get reverseGeocode(): Operation<ReverseGeocodeArgs, Feature>;
|
|
83
86
|
}
|
|
@@ -132,12 +132,14 @@ export interface GnssDeviceConnectionInfo {
|
|
|
132
132
|
*/
|
|
133
133
|
deviceFullName: string;
|
|
134
134
|
/**
|
|
135
|
-
* The type of the device. Options are Integrated, Bluetooth, USB, and
|
|
135
|
+
* The type of the device. Options are Integrated, Bluetooth, USB, and
|
|
136
|
+
* Emulator.
|
|
136
137
|
*/
|
|
137
138
|
deviceType: GnssDeviceType;
|
|
138
139
|
/**
|
|
139
140
|
* The device settings, including the correction service's spatial
|
|
140
|
-
* reference, the desired datum transformation, and the device's antenna
|
|
141
|
+
* reference, the desired datum transformation, and the device's antenna
|
|
142
|
+
* height.
|
|
141
143
|
*/
|
|
142
144
|
settings: GnssDeviceSettings;
|
|
143
145
|
}
|
|
@@ -333,7 +335,8 @@ export declare class GeolocationOperations extends OperationRegistry {
|
|
|
333
335
|
}
|
|
334
336
|
export declare class GeolocationEvents extends EventRegistry {
|
|
335
337
|
/**
|
|
336
|
-
* Raised when geolocation is activated and the accuracy of geolocation
|
|
338
|
+
* Raised when geolocation is activated and the accuracy of geolocation
|
|
339
|
+
* changes.
|
|
337
340
|
*/
|
|
338
341
|
get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
|
|
339
342
|
/**
|
|
@@ -344,24 +347,28 @@ export declare class GeolocationEvents extends EventRegistry {
|
|
|
344
347
|
*/
|
|
345
348
|
get metadataChanged(): Event<GeolocateMetadataChangedEventArgs>;
|
|
346
349
|
/**
|
|
347
|
-
* Raised when geolocation enters auto recenter mode. For
|
|
348
|
-
* Viewer, the event will have no parameter (all maps are always
|
|
350
|
+
* Raised when geolocation enters auto recenter mode. For VertiGIS Studio
|
|
351
|
+
* Web Viewer, the event will have no parameter (all maps are always
|
|
352
|
+
* affected).
|
|
349
353
|
*/
|
|
350
354
|
get autoRecenterStarted(): Event<HasMaps | void>;
|
|
351
355
|
/**
|
|
352
356
|
* Raised when the user changes the geolocation mode to
|
|
353
|
-
* recenter-and-reorient (updates map orientation to match device
|
|
357
|
+
* recenter-and-reorient (updates map orientation to match device
|
|
358
|
+
* direction).
|
|
354
359
|
*
|
|
355
360
|
* @mobileOnly
|
|
356
361
|
*/
|
|
357
362
|
get autoRecenterAndReorientStarted(): Event<HasMaps>;
|
|
358
363
|
/**
|
|
359
|
-
* Raised when geolocation leaves auto recenter mode. For
|
|
360
|
-
* Viewer, the event will have no parameter (all maps are always
|
|
364
|
+
* Raised when geolocation leaves auto recenter mode. For VertiGIS Studio
|
|
365
|
+
* Web Viewer, the event will have no parameter (all maps are always
|
|
366
|
+
* affected).
|
|
361
367
|
*/
|
|
362
368
|
get autoRecenterStopped(): Event<HasMaps | void>;
|
|
363
369
|
/**
|
|
364
|
-
* Raised when the user changes the geolocation mode to not
|
|
370
|
+
* Raised when the user changes the geolocation mode to not
|
|
371
|
+
* recenter-and-reorient.
|
|
365
372
|
*
|
|
366
373
|
* @mobileOnly
|
|
367
374
|
*/
|
|
@@ -391,7 +398,8 @@ export declare class GeolocationEvents extends EventRegistry {
|
|
|
391
398
|
*/
|
|
392
399
|
get headingChanged(): Event<number>;
|
|
393
400
|
/**
|
|
394
|
-
* Raised when geolocation is activated and a user position has been
|
|
401
|
+
* Raised when geolocation is activated and a user position has been
|
|
402
|
+
* received.
|
|
395
403
|
*/
|
|
396
404
|
get positionAcquired(): Event<GeolocationEvent>;
|
|
397
405
|
/**
|
|
@@ -411,7 +419,8 @@ export declare class GeolocationEvents extends EventRegistry {
|
|
|
411
419
|
*/
|
|
412
420
|
get sourceChanged(): Event<GnssDeviceConnectionInfo>;
|
|
413
421
|
/**
|
|
414
|
-
* Raised when geolocation status (enabled or disabled via app permissions)
|
|
422
|
+
* Raised when geolocation status (enabled or disabled via app permissions)
|
|
423
|
+
* changes.
|
|
415
424
|
*/
|
|
416
425
|
get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
|
|
417
426
|
/**
|
|
@@ -106,7 +106,8 @@ export interface ReferenceLine {
|
|
|
106
106
|
segmentIndex?: number;
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
|
-
* The different types of curves that can be used for geodetic distance
|
|
109
|
+
* The different types of curves that can be used for geodetic distance
|
|
110
|
+
* calculations.
|
|
110
111
|
*/
|
|
111
112
|
export declare type GeodeticCurveType = "geodesic" | "loxodrome" | "normal-section" | "great-elliptic";
|
|
112
113
|
/**
|
|
@@ -135,7 +136,8 @@ export interface CalculatePointArgs {
|
|
|
135
136
|
distance: number;
|
|
136
137
|
/**
|
|
137
138
|
* The offset that will be used to calculate the new point. The 'offset'
|
|
138
|
-
* corresponds to the distance perpendicularly away from the reference
|
|
139
|
+
* corresponds to the distance perpendicularly away from the reference
|
|
140
|
+
* line.
|
|
139
141
|
*
|
|
140
142
|
* Positive values will result in a point to the right of the reference
|
|
141
143
|
* line, negative values will be to the left.
|
|
@@ -146,13 +148,15 @@ export interface CalculatePointArgs {
|
|
|
146
148
|
/**
|
|
147
149
|
* The angle, relative to the angle of the reference line, that will be used
|
|
148
150
|
* to calculate the new point. Positive angles are calculated clockwise from
|
|
149
|
-
* the angle of the reference line, negative angles are calculated
|
|
151
|
+
* the angle of the reference line, negative angles are calculated
|
|
152
|
+
* counter-clockwise.
|
|
150
153
|
*
|
|
151
154
|
* Exactly one of 'offset' and 'angle' must be set.
|
|
152
155
|
*/
|
|
153
156
|
angle?: number;
|
|
154
157
|
/**
|
|
155
|
-
* Whether the distance calculations will be geodetic or planar. Defaults to
|
|
158
|
+
* Whether the distance calculations will be geodetic or planar. Defaults to
|
|
159
|
+
* true.
|
|
156
160
|
*/
|
|
157
161
|
geodetic?: boolean;
|
|
158
162
|
/**
|
|
@@ -175,7 +179,8 @@ export interface RemovePointArgs {
|
|
|
175
179
|
*/
|
|
176
180
|
partIndex?: number;
|
|
177
181
|
/**
|
|
178
|
-
* The index of the point to be removed. If null, the last point wil be
|
|
182
|
+
* The index of the point to be removed. If null, the last point wil be
|
|
183
|
+
* removed.
|
|
179
184
|
*/
|
|
180
185
|
pointIndex?: number;
|
|
181
186
|
}
|
|
@@ -21,7 +21,8 @@ export interface UpdateKpiCardDefinitionArgs {
|
|
|
21
21
|
*/
|
|
22
22
|
kpiCard: ModelRef;
|
|
23
23
|
/**
|
|
24
|
-
* The stringified Arcade script used to calculate the 'value' token of the
|
|
24
|
+
* The stringified Arcade script used to calculate the 'value' token of the
|
|
25
|
+
* KPI Card.
|
|
25
26
|
*/
|
|
26
27
|
valueExpression?: string;
|
|
27
28
|
/**
|
|
@@ -35,7 +36,8 @@ export interface UpdateKpiCardDefinitionArgs {
|
|
|
35
36
|
*/
|
|
36
37
|
export interface GetKpiDefinitionResult {
|
|
37
38
|
/**
|
|
38
|
-
* The stringified Arcade script used to calculate the 'value' token of the
|
|
39
|
+
* The stringified Arcade script used to calculate the 'value' token of the
|
|
40
|
+
* KPI card.
|
|
39
41
|
*/
|
|
40
42
|
valueExpression: string;
|
|
41
43
|
/**
|
|
@@ -33,7 +33,8 @@ export declare class LayoutEvents extends EventRegistry {
|
|
|
33
33
|
*/
|
|
34
34
|
get loaded(): Event<Page>;
|
|
35
35
|
/**
|
|
36
|
-
* Raised when a layout is unloaded (typically so that a new layout can be
|
|
36
|
+
* Raised when a layout is unloaded (typically so that a new layout can be
|
|
37
|
+
* loaded).
|
|
37
38
|
*
|
|
38
39
|
* @mobileOnly
|
|
39
40
|
*/
|
|
@@ -53,7 +53,8 @@ export interface LocationMarkerEvent {
|
|
|
53
53
|
color: Color | ColorJson;
|
|
54
54
|
/**
|
|
55
55
|
* Indicates the horizontal field of view in degrees for the marker. Ranges
|
|
56
|
-
* from 0 to 360. This property is currently only supported by the "dot"
|
|
56
|
+
* from 0 to 360. This property is currently only supported by the "dot"
|
|
57
|
+
* symbol.
|
|
57
58
|
*/
|
|
58
59
|
fov: number;
|
|
59
60
|
/**
|
|
@@ -62,7 +63,8 @@ export interface LocationMarkerEvent {
|
|
|
62
63
|
heading: number;
|
|
63
64
|
/**
|
|
64
65
|
* In 3D, the tilt angle of the location marker symbol. Ranges from 0
|
|
65
|
-
* (straight down) to 180 (straight up) degrees. Defaults to 90 (straight
|
|
66
|
+
* (straight down) to 180 (straight up) degrees. Defaults to 90 (straight
|
|
67
|
+
* ahead).
|
|
66
68
|
*/
|
|
67
69
|
tilt?: number;
|
|
68
70
|
/**
|
|
@@ -89,7 +91,8 @@ export declare type CreateLocationMarkerArgs = Partial<LocationMarkerEvent> & Re
|
|
|
89
91
|
*/
|
|
90
92
|
onUpdate?: Action;
|
|
91
93
|
/**
|
|
92
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
94
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
95
|
+
* targeted.
|
|
93
96
|
*/
|
|
94
97
|
maps?: MapsRef;
|
|
95
98
|
};
|
|
@@ -102,7 +105,8 @@ export declare type UpdateLocationMarkerArgs = Partial<LocationMarkerEvent> & Re
|
|
|
102
105
|
*/
|
|
103
106
|
onUpdate?: Action;
|
|
104
107
|
/**
|
|
105
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
108
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
109
|
+
* targeted.
|
|
106
110
|
*/
|
|
107
111
|
maps?: MapsRef;
|
|
108
112
|
};
|
|
@@ -115,7 +119,8 @@ export interface RemoveLocationMarkerArgs {
|
|
|
115
119
|
*/
|
|
116
120
|
id?: string;
|
|
117
121
|
/**
|
|
118
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
122
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
123
|
+
* targeted.
|
|
119
124
|
*/
|
|
120
125
|
maps?: MapsRef;
|
|
121
126
|
}
|
|
@@ -37,11 +37,12 @@ export interface MapEvent {
|
|
|
37
37
|
*/
|
|
38
38
|
maps?: MapsLike;
|
|
39
39
|
/**
|
|
40
|
-
* The map extension for which the event was generated.
|
|
40
|
+
* The map extension for which the event was generated. This property is
|
|
41
|
+
* required in VertiGIS Studio Mobile.
|
|
41
42
|
*
|
|
42
43
|
* @mobileOnly
|
|
43
44
|
*/
|
|
44
|
-
mapExtension
|
|
45
|
+
mapExtension?: MapExtension;
|
|
45
46
|
}
|
|
46
47
|
/**
|
|
47
48
|
* Arguments for the ViewModeChanged event.
|
|
@@ -271,7 +272,8 @@ export interface GetCoordinateArgs extends HasUITarget {
|
|
|
271
272
|
*/
|
|
272
273
|
maps?: MapsLike;
|
|
273
274
|
/**
|
|
274
|
-
* Indicates if the user should be given the option to select a point from
|
|
275
|
+
* Indicates if the user should be given the option to select a point from
|
|
276
|
+
* the map.
|
|
275
277
|
*/
|
|
276
278
|
allowSelectFromMap?: boolean;
|
|
277
279
|
/**
|
|
@@ -381,7 +383,8 @@ export interface FilterEffectSettings {
|
|
|
381
383
|
contrast?: string;
|
|
382
384
|
}
|
|
383
385
|
/**
|
|
384
|
-
* A feature mode for use with filter effects (see
|
|
386
|
+
* A feature mode for use with filter effects (see
|
|
387
|
+
* `ApplyFilterEffectArgs.featureMode`).
|
|
385
388
|
*/
|
|
386
389
|
export declare type FilterEffectFeatureMode = "include" | "exclude" | "replace";
|
|
387
390
|
/**
|
|
@@ -705,7 +708,8 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
705
708
|
/**
|
|
706
709
|
* Add the specified layer(s) to the maps(s). Layers will be inserted in the
|
|
707
710
|
* order specified and will be added above existing layers in the drawing
|
|
708
|
-
* order. Note that an Esri {@link Layer} object can only be added to one
|
|
711
|
+
* order. Note that an Esri {@link Layer} object can only be added to one
|
|
712
|
+
* map.
|
|
709
713
|
*
|
|
710
714
|
* @webOnly
|
|
711
715
|
*/
|
|
@@ -778,7 +782,8 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
778
782
|
*/
|
|
779
783
|
get goToFeatures(): Command<Features>;
|
|
780
784
|
/**
|
|
781
|
-
* Zooms to (without animation) one or many geometries on the targeted
|
|
785
|
+
* Zooms to (without animation) one or many geometries on the targeted
|
|
786
|
+
* map(s).
|
|
782
787
|
*
|
|
783
788
|
* @webOnly
|
|
784
789
|
*/
|
|
@@ -804,7 +809,8 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
804
809
|
get goToInitialViewpoint(): Command<Maps | void>;
|
|
805
810
|
/**
|
|
806
811
|
* Go to (without animation) the full extent of the layer(s). If more than
|
|
807
|
-
* one layer is specified, it will zoom to the combined extent of all
|
|
812
|
+
* one layer is specified, it will zoom to the combined extent of all
|
|
813
|
+
* layers.
|
|
808
814
|
*
|
|
809
815
|
* @webOnly
|
|
810
816
|
*/
|
|
@@ -1095,7 +1101,8 @@ export declare class MapOperations extends OperationRegistry {
|
|
|
1095
1101
|
/**
|
|
1096
1102
|
* Returns the current viewpoint for the active map or scene of the
|
|
1097
1103
|
* specified map. If no map extension is specified, returns the viewpoint
|
|
1098
|
-
* for the first available map. Also returns the map(s) used for the
|
|
1104
|
+
* for the first available map. Also returns the map(s) used for the
|
|
1105
|
+
* operation.
|
|
1099
1106
|
*
|
|
1100
1107
|
* @webOnly
|
|
1101
1108
|
*/
|
|
@@ -14,7 +14,8 @@ declare enum GeometryMode {
|
|
|
14
14
|
AREA = "area"
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* Arguments for the measurement.get-symbol operation. Only available in
|
|
17
|
+
* Arguments for the measurement.get-symbol operation. Only available in
|
|
18
|
+
* VertiGIS Studio Web.
|
|
18
19
|
*/
|
|
19
20
|
export interface GetDefaultSymbolArgs {
|
|
20
21
|
/**
|
|
@@ -23,7 +24,8 @@ export interface GetDefaultSymbolArgs {
|
|
|
23
24
|
geometryType?: GeometryType;
|
|
24
25
|
}
|
|
25
26
|
/**
|
|
26
|
-
* Arguments for the measurement events. Only available in VertiGIS Studio
|
|
27
|
+
* Arguments for the measurement events. Only available in VertiGIS Studio
|
|
28
|
+
* Mobile.
|
|
27
29
|
*/
|
|
28
30
|
export interface GeometryModeArgs extends HasMaps {
|
|
29
31
|
/**
|
|
@@ -14,7 +14,7 @@ export declare class MessagingOperations extends OperationRegistry {
|
|
|
14
14
|
*
|
|
15
15
|
* Note that argument merging already occurs automatically in command
|
|
16
16
|
* chains; this explicit operation exists for advanced scenarios like
|
|
17
|
-
*
|
|
17
|
+
* VertiGIS Studio Workflow or custom code written using the SDK.
|
|
18
18
|
*
|
|
19
19
|
* @webOnly
|
|
20
20
|
*/
|