@vertigis/viewer-spec 47.5.0 → 48.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.
- package/app-config/AppConfig.d.ts +3 -6
- package/app-config/common/AnalyticsModelProperties.d.ts +10 -0
- package/app-config/common/AnalyticsModelProperties.js +1 -0
- package/app-config/common/BrandingThemeProperties.d.ts +2 -4
- package/app-config/common/HighlightModelProperties.d.ts +2 -4
- package/app-config/common/LayerPresetsModelProperties.d.ts +1 -2
- package/app-config/common/LayoutProperties.d.ts +3 -3
- package/app-config/common/RegionModelProperties.d.ts +1 -2
- package/app-config/common/SearchModelProperties.d.ts +2 -2
- package/app-config/common/WorkflowModelProperties.d.ts +2 -4
- package/app-config/mobile/FeatureDetailsModelProperties.d.ts +2 -1
- package/app-config/mobile/SearchModelProperties.d.ts +3 -1
- package/app-config/mobile/VertigisMobileModelProperties.d.ts +17 -16
- 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/DrawModelProperties.d.ts +1 -2
- package/app-config/web/FeatureDetailsModelProperties.d.ts +2 -2
- package/app-config/web/HasVisibilityFilters.d.ts +4 -4
- package/app-config/web/KpiCardModelProperties.d.ts +10 -10
- package/app-config/web/MapCoordinatesModelProperties.d.ts +1 -2
- package/app-config/web/MapModelProperties.d.ts +2 -4
- package/app-config/web/MeasurementModelProperties.d.ts +1 -2
- package/app-config/web/ResultsModelProperties.d.ts +2 -2
- package/app-config/web/SearchModelProperties.d.ts +1 -2
- package/app-config/web/VertigisWebModelProperties.d.ts +8 -10
- package/layout/schema/layout-common.xsd +843 -830
- package/layout/schema/layout-mobile.xsd +241 -234
- package/layout/schema/layout-web.xsd +281 -277
- package/layout/schema/schema-reference-example.xml +11 -10
- package/messaging/Command.d.ts +1 -2
- package/messaging/Event.d.ts +2 -4
- package/messaging/MessageBus.d.ts +2 -2
- package/messaging/Operation.d.ts +1 -2
- package/messaging/common.d.ts +9 -14
- package/messaging/registry/app.d.ts +6 -10
- package/messaging/registry/arcade.d.ts +3 -7
- package/messaging/registry/auth.d.ts +6 -10
- package/messaging/registry/basemap.d.ts +8 -8
- package/messaging/registry/charts.d.ts +2 -2
- package/messaging/registry/debugConsole.d.ts +3 -4
- package/messaging/registry/drawing.d.ts +3 -6
- package/messaging/registry/edit.d.ts +9 -14
- package/messaging/registry/geolocation.d.ts +13 -20
- package/messaging/registry/geometry.d.ts +26 -31
- package/messaging/registry/kpi.d.ts +2 -4
- package/messaging/registry/layer-comparison.d.ts +2 -2
- package/messaging/registry/layout.d.ts +1 -2
- package/messaging/registry/location-marker.d.ts +5 -10
- package/messaging/registry/map.d.ts +21 -22
- package/messaging/registry/measurement.d.ts +6 -8
- package/messaging/registry/messaging.d.ts +3 -3
- package/messaging/registry/offline.d.ts +19 -24
- package/messaging/registry/panel.d.ts +1 -2
- package/messaging/registry/portal.d.ts +1 -2
- package/messaging/registry/printing.d.ts +3 -4
- package/messaging/registry/results.d.ts +8 -16
- package/messaging/registry/sketching.d.ts +27 -40
- package/messaging/registry/system.d.ts +6 -6
- package/messaging/registry/tasks.d.ts +4 -6
- package/messaging/registry/ui.d.ts +12 -18
- package/messaging/registry/viewer.d.ts +1 -2
- package/messaging/registry/workflow.d.ts +2 -4
- package/messaging/schema/web-action.schema.json +1 -1
- package/package.json +17 -17
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -53,8 +53,7 @@ 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"
|
|
57
|
-
* symbol.
|
|
56
|
+
* from 0 to 360. This property is currently only supported by the "dot" symbol.
|
|
58
57
|
*/
|
|
59
58
|
fov: number;
|
|
60
59
|
/**
|
|
@@ -63,8 +62,7 @@ export interface LocationMarkerEvent {
|
|
|
63
62
|
heading: number;
|
|
64
63
|
/**
|
|
65
64
|
* In 3D, the tilt angle of the location marker symbol. Ranges from 0
|
|
66
|
-
* (straight down) to 180 (straight up) degrees. Defaults to 90 (straight
|
|
67
|
-
* ahead).
|
|
65
|
+
* (straight down) to 180 (straight up) degrees. Defaults to 90 (straight ahead).
|
|
68
66
|
*/
|
|
69
67
|
tilt?: number;
|
|
70
68
|
/**
|
|
@@ -91,8 +89,7 @@ export declare type CreateLocationMarkerArgs = Partial<LocationMarkerEvent> & Re
|
|
|
91
89
|
*/
|
|
92
90
|
onUpdate?: Action;
|
|
93
91
|
/**
|
|
94
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
95
|
-
* targeted.
|
|
92
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be targeted.
|
|
96
93
|
*/
|
|
97
94
|
maps?: MapsRef;
|
|
98
95
|
};
|
|
@@ -105,8 +102,7 @@ export declare type UpdateLocationMarkerArgs = Partial<LocationMarkerEvent> & Re
|
|
|
105
102
|
*/
|
|
106
103
|
onUpdate?: Action;
|
|
107
104
|
/**
|
|
108
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
109
|
-
* targeted.
|
|
105
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be targeted.
|
|
110
106
|
*/
|
|
111
107
|
maps?: MapsRef;
|
|
112
108
|
};
|
|
@@ -119,8 +115,7 @@ export interface RemoveLocationMarkerArgs {
|
|
|
119
115
|
*/
|
|
120
116
|
id?: string;
|
|
121
117
|
/**
|
|
122
|
-
* The map(s) for the Marker. If maps are undefined, all maps will be
|
|
123
|
-
* targeted.
|
|
118
|
+
* The map(s) for the Marker. If maps are undefined, all maps will be targeted.
|
|
124
119
|
*/
|
|
125
120
|
maps?: MapsRef;
|
|
126
121
|
}
|
|
@@ -271,7 +271,7 @@ export interface GetCoordinateArgs extends HasUITarget {
|
|
|
271
271
|
geometry?: Point;
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
*
|
|
274
|
+
* The result of a map.get-user-coordinates-input operation.
|
|
275
275
|
*/
|
|
276
276
|
export interface GetCoordinateResult {
|
|
277
277
|
/**
|
|
@@ -372,8 +372,7 @@ export interface FilterEffectSettings {
|
|
|
372
372
|
contrast?: string;
|
|
373
373
|
}
|
|
374
374
|
/**
|
|
375
|
-
* A feature mode for use with filter effects (see
|
|
376
|
-
* `ApplyFilterEffectArgs.featureMode`).
|
|
375
|
+
* A feature mode for use with filter effects (see `ApplyFilterEffectArgs.featureMode`).
|
|
377
376
|
*/
|
|
378
377
|
export declare type FilterEffectFeatureMode = "include" | "exclude" | "replace";
|
|
379
378
|
/**
|
|
@@ -381,8 +380,8 @@ export declare type FilterEffectFeatureMode = "include" | "exclude" | "replace";
|
|
|
381
380
|
*/
|
|
382
381
|
export interface ApplyFilterEffectArgs {
|
|
383
382
|
/**
|
|
384
|
-
* The layer(s) to which the filter effect will be applied. When defined,
|
|
385
|
-
* filter only gets set on the corresponding LayerView. If no 'layer' is
|
|
383
|
+
* The layer(s) to which the filter effect will be applied. When defined,
|
|
384
|
+
* the filter only gets set on the corresponding LayerView. If no 'layer' is
|
|
386
385
|
* defined, all applicable layers included in the specified 'maps' will
|
|
387
386
|
* receive the filter effect.
|
|
388
387
|
*/
|
|
@@ -422,8 +421,8 @@ export interface ApplyFilterEffectArgs {
|
|
|
422
421
|
*/
|
|
423
422
|
geometry?: Geometry;
|
|
424
423
|
/**
|
|
425
|
-
* The spatial relationship to filter features in the layer view against
|
|
426
|
-
*
|
|
424
|
+
* The spatial relationship to filter features in the layer view against the
|
|
425
|
+
* filter 'geometry'.
|
|
427
426
|
*/
|
|
428
427
|
spatialRelationship?: FilterSpatialRelationship;
|
|
429
428
|
/**
|
|
@@ -571,15 +570,15 @@ export interface StartSketchArgs {
|
|
|
571
570
|
*/
|
|
572
571
|
resumeId: string;
|
|
573
572
|
/**
|
|
574
|
-
* The size of the buffer to be created around the geometry. If null or a
|
|
575
|
-
* value, no buffer will be created.
|
|
573
|
+
* The size of the buffer to be created around the geometry. If null or a
|
|
574
|
+
* negative value, no buffer will be created.
|
|
576
575
|
*
|
|
577
576
|
* This is currently only supported for line geometry types.
|
|
578
577
|
*/
|
|
579
578
|
bufferSize: number;
|
|
580
579
|
/**
|
|
581
|
-
* A value indicating whether the previous geometry editor settings
|
|
582
|
-
*
|
|
580
|
+
* A value indicating whether the previous geometry editor settings should
|
|
581
|
+
* be restored after this sketch is stopped.
|
|
583
582
|
*/
|
|
584
583
|
retainEditorSettings: boolean;
|
|
585
584
|
/**
|
|
@@ -631,10 +630,9 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
631
630
|
*/
|
|
632
631
|
get addMarkup(): Command<GraphicsLike>;
|
|
633
632
|
/**
|
|
634
|
-
* Add the specified layer(s) to the maps(s). Layers will be
|
|
635
|
-
*
|
|
636
|
-
*
|
|
637
|
-
* {@link Layer} object can only be added to one map.
|
|
633
|
+
* Add the specified layer(s) to the maps(s). Layers will be inserted in the
|
|
634
|
+
* order specified and will be added above existing layers in the drawing
|
|
635
|
+
* order. Note that an Esri {@link Layer} object can only be added to one map.
|
|
638
636
|
*
|
|
639
637
|
* @webOnly
|
|
640
638
|
*/
|
|
@@ -735,8 +733,7 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
735
733
|
get goToInitialViewpoint(): Command<Maps | void>;
|
|
736
734
|
/**
|
|
737
735
|
* Go to (without animation) the full extent of the layer(s). If more than
|
|
738
|
-
* one layer is specified, it will zoom to the combined extent of all
|
|
739
|
-
* layers.
|
|
736
|
+
* one layer is specified, it will zoom to the combined extent of all layers.
|
|
740
737
|
*
|
|
741
738
|
* @webOnly
|
|
742
739
|
*/
|
|
@@ -771,19 +768,22 @@ export declare class MapCommands extends CommandRegistry {
|
|
|
771
768
|
*/
|
|
772
769
|
get removeLayers(): Command<LayersLike | RemoveLayersArgs>;
|
|
773
770
|
/**
|
|
774
|
-
* Replaces the entire current map in the MapExtension and in the map
|
|
771
|
+
* Replaces the entire current map in the MapExtension and in the map
|
|
772
|
+
* component with a different map.
|
|
775
773
|
*
|
|
776
774
|
* @mobileOnly
|
|
777
775
|
*/
|
|
778
776
|
get replace(): Command<ReplaceMapArgs>;
|
|
779
777
|
/**
|
|
780
|
-
* Replaces the additional layers on top of an mmpk with a new set of
|
|
778
|
+
* Replaces the additional layers on top of an mmpk with a new set of
|
|
779
|
+
* layers, when using mmpk + WebMap. The mmpk part of the map is retained.
|
|
781
780
|
*
|
|
782
781
|
* @mobileOnly
|
|
783
782
|
*/
|
|
784
783
|
get replaceAdditionalLayers(): Command<ReplaceMapArgs>;
|
|
785
784
|
/**
|
|
786
|
-
* Replaces the underlying mmpk part of the map when using mmpk + WebMap.
|
|
785
|
+
* Replaces the underlying mmpk part of the map when using mmpk + WebMap.
|
|
786
|
+
* The additional layers on top of the mmpk data are retained.
|
|
787
787
|
*
|
|
788
788
|
* @mobileOnly
|
|
789
789
|
*/
|
|
@@ -985,8 +985,7 @@ export declare class MapOperations extends OperationRegistry {
|
|
|
985
985
|
/**
|
|
986
986
|
* Returns the current viewpoint for the active map or scene of the
|
|
987
987
|
* specified map. If no map extension is specified, returns the viewpoint
|
|
988
|
-
* for the first available map. Also returns the map(s) used for the
|
|
989
|
-
* operation.
|
|
988
|
+
* for the first available map. Also returns the map(s) used for the operation.
|
|
990
989
|
*
|
|
991
990
|
* @webOnly
|
|
992
991
|
*/
|
|
@@ -13,8 +13,7 @@ declare enum GeometryMode {
|
|
|
13
13
|
AREA = "area"
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* Arguments for the measurement.get-symbol operation. Only available in Geocortex
|
|
17
|
-
* Web.
|
|
16
|
+
* Arguments for the measurement.get-symbol operation. Only available in Geocortex Web.
|
|
18
17
|
*/
|
|
19
18
|
export interface GetDefaultSymbolArgs {
|
|
20
19
|
/**
|
|
@@ -23,8 +22,7 @@ export interface GetDefaultSymbolArgs {
|
|
|
23
22
|
geometryType?: GeometryType;
|
|
24
23
|
}
|
|
25
24
|
/**
|
|
26
|
-
* Arguments for the measurement events. Only available in the Geocortex Mobile
|
|
27
|
-
* Viewer.
|
|
25
|
+
* Arguments for the measurement events. Only available in the Geocortex Mobile Viewer.
|
|
28
26
|
*/
|
|
29
27
|
export interface GeometryModeArgs extends MapExtensionArgs {
|
|
30
28
|
/**
|
|
@@ -61,8 +59,8 @@ export declare class MeasurementCommands extends CommandRegistry {
|
|
|
61
59
|
*/
|
|
62
60
|
get setAreaUnits(): Command<AreaMeasurementUnits | undefined>;
|
|
63
61
|
/**
|
|
64
|
-
* Sets the length units used for measurements. Set as undefined for units
|
|
65
|
-
* be intelligently selected based on dimensions.
|
|
62
|
+
* Sets the length units used for measurements. Set as undefined for units
|
|
63
|
+
* to be intelligently selected based on dimensions.
|
|
66
64
|
*
|
|
67
65
|
* @webOnly
|
|
68
66
|
*/
|
|
@@ -125,8 +123,8 @@ export declare class MeasurementOperations extends OperationRegistry {
|
|
|
125
123
|
*/
|
|
126
124
|
get getDefaultSymbol3D(): Operation<GetDefaultSymbolArgs | GeometryType, DrawingSymbolConfig>;
|
|
127
125
|
/**
|
|
128
|
-
* Gets the area units used for measurements. If undefined the units will
|
|
129
|
-
*
|
|
126
|
+
* Gets the area units used for measurements. If undefined the units will be
|
|
127
|
+
* selected intelligently based on dimensions.
|
|
130
128
|
*
|
|
131
129
|
* @webOnly
|
|
132
130
|
*/
|
|
@@ -4,9 +4,9 @@ export declare class MessagingOperations extends OperationRegistry {
|
|
|
4
4
|
/**
|
|
5
5
|
* Attempts to merge an array of values into a single value that can be used
|
|
6
6
|
* as an argument for a command or operation. For example:
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
7
|
+
*
|
|
8
|
+
* [features, { chart: "average-household-income" }];
|
|
9
|
+
*
|
|
10
10
|
* This would mix `features` obtained from some other source into arguments
|
|
11
11
|
* intended for the "charts.display" command.
|
|
12
12
|
*
|
|
@@ -56,14 +56,15 @@ export interface OfflineAreaBase {
|
|
|
56
56
|
export interface CustomOfflineArea {
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
* Corresponds to
|
|
60
|
-
*
|
|
59
|
+
* Corresponds to
|
|
60
|
+
* `VertiGIS.Mobile.Infrastructure.Offline.CustomOfflineAreaDetails` in the
|
|
61
|
+
* VertiGIS.Mobile SDK.
|
|
61
62
|
*/
|
|
62
63
|
export interface CustomOfflineAreaDetails {
|
|
63
64
|
}
|
|
64
65
|
/**
|
|
65
|
-
* Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.LayerEdits` in
|
|
66
|
-
*
|
|
66
|
+
* Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.LayerEdits` in the
|
|
67
|
+
* VertiGIS.Mobile SDK.
|
|
67
68
|
*/
|
|
68
69
|
export interface LayerEdits {
|
|
69
70
|
/**
|
|
@@ -96,13 +97,12 @@ export interface OfflineOperationResult {
|
|
|
96
97
|
*/
|
|
97
98
|
success: boolean;
|
|
98
99
|
/**
|
|
99
|
-
* The Exception that occurred during the operation, or null if no Exception
|
|
100
|
-
* occurred.
|
|
100
|
+
* The Exception that occurred during the operation, or null if no Exception occurred.
|
|
101
101
|
*/
|
|
102
102
|
error: Exception;
|
|
103
103
|
/**
|
|
104
|
-
* An <see cref="OfflineErrorCode"/> enum value indicating the type of
|
|
105
|
-
*
|
|
104
|
+
* An <see cref="OfflineErrorCode"/> enum value indicating the type of error
|
|
105
|
+
* that occurred, or null if successful.
|
|
106
106
|
*/
|
|
107
107
|
errorCode: OfflineErrorCode;
|
|
108
108
|
/**
|
|
@@ -112,7 +112,8 @@ export interface OfflineOperationResult {
|
|
|
112
112
|
*/
|
|
113
113
|
errorCodeString: string;
|
|
114
114
|
/**
|
|
115
|
-
* A localized, end-user presentable error message, or null if the operation
|
|
115
|
+
* A localized, end-user presentable error message, or null if the operation
|
|
116
|
+
* was successful.
|
|
116
117
|
*/
|
|
117
118
|
errorMessage: string;
|
|
118
119
|
/**
|
|
@@ -144,8 +145,7 @@ export interface OfflineOperationResult {
|
|
|
144
145
|
*/
|
|
145
146
|
export declare enum OfflineErrorCode {
|
|
146
147
|
/**
|
|
147
|
-
* The operation requires network connectivity, but the network is
|
|
148
|
-
* disconnected.
|
|
148
|
+
* The operation requires network connectivity, but the network is disconnected.
|
|
149
149
|
*/
|
|
150
150
|
NETWORK_CONNECTION_REQUIRED = 100,
|
|
151
151
|
/**
|
|
@@ -165,8 +165,7 @@ export declare enum OfflineErrorCode {
|
|
|
165
165
|
*/
|
|
166
166
|
INVALID_MAP_AREA_DATA = 104,
|
|
167
167
|
/**
|
|
168
|
-
* The amount of allowable time spent with the app in the background was
|
|
169
|
-
* exceeded.
|
|
168
|
+
* The amount of allowable time spent with the app in the background was exceeded.
|
|
170
169
|
*/
|
|
171
170
|
BACKGROUND_TIME_EXPIRED = 105,
|
|
172
171
|
/**
|
|
@@ -199,23 +198,20 @@ export declare class OfflineCommands extends CommandRegistry {
|
|
|
199
198
|
*/
|
|
200
199
|
get cancelCreateArea(): Command;
|
|
201
200
|
/**
|
|
202
|
-
* Cancels the download of the specified offline area, if it is currently in
|
|
203
|
-
* progress.
|
|
201
|
+
* Cancels the download of the specified offline area, if it is currently in progress.
|
|
204
202
|
*
|
|
205
203
|
* @mobileOnly
|
|
206
204
|
*/
|
|
207
205
|
get cancelDownload(): Command<OfflineCommandArgs>;
|
|
208
206
|
/**
|
|
209
207
|
* Deletes the data stored on the device for the specified offline area. The
|
|
210
|
-
* offline map area definition is not deleted, so that it can be
|
|
211
|
-
* re-downloaded.
|
|
208
|
+
* offline map area definition is not deleted, so that it can be re-downloaded.
|
|
212
209
|
*
|
|
213
210
|
* @mobileOnly
|
|
214
211
|
*/
|
|
215
212
|
get deleteArea(): Command<OfflineCommandArgs>;
|
|
216
213
|
/**
|
|
217
|
-
* Displays a form that allows for the creation of a custom offline map
|
|
218
|
-
* area.
|
|
214
|
+
* Displays a form that allows for the creation of a custom offline map area.
|
|
219
215
|
*
|
|
220
216
|
* @mobileOnly
|
|
221
217
|
*/
|
|
@@ -335,21 +331,20 @@ export declare class OfflineOperations extends OperationRegistry {
|
|
|
335
331
|
*/
|
|
336
332
|
get goOnline(): Operation<OfflineCommandArgs, OfflineOperationResult>;
|
|
337
333
|
/**
|
|
338
|
-
* Checks whether a map area is active for the specified map, or for any map
|
|
334
|
+
* Checks whether a map area is active for the specified map, or for any map
|
|
335
|
+
* if argument is null.
|
|
339
336
|
*
|
|
340
337
|
* @mobileOnly
|
|
341
338
|
*/
|
|
342
339
|
get checkForActiveArea(): Operation<MapExtension, boolean>;
|
|
343
340
|
/**
|
|
344
|
-
* Pushes any edits to the server that have been done in the indicated
|
|
345
|
-
* offline map.
|
|
341
|
+
* Pushes any edits to the server that have been done in the indicated offline map.
|
|
346
342
|
*
|
|
347
343
|
* @mobileOnly
|
|
348
344
|
*/
|
|
349
345
|
get submitEdits(): Operation<OfflineCommandArgs, OfflineOperationResult>;
|
|
350
346
|
/**
|
|
351
|
-
* Pulls down any new map changes from the server to the indicated offline
|
|
352
|
-
* map.
|
|
347
|
+
* Pulls down any new map changes from the server to the indicated offline map.
|
|
353
348
|
*
|
|
354
349
|
* @mobileOnly
|
|
355
350
|
*/
|
|
@@ -59,8 +59,7 @@ export declare class PanelCommands extends CommandRegistry {
|
|
|
59
59
|
/**
|
|
60
60
|
* Closes the host panel. If a component is specified, the panel is only
|
|
61
61
|
* closed if the specified component is currently open in the host panel. If
|
|
62
|
-
* no component is specified (input null), then the host panel will always
|
|
63
|
-
* be closed.
|
|
62
|
+
* no component is specified (input null), then the host panel will always be closed.
|
|
64
63
|
*
|
|
65
64
|
* @mobileOnly
|
|
66
65
|
*/
|
|
@@ -14,8 +14,7 @@ export interface ArcGISPortalExtension {
|
|
|
14
14
|
*/
|
|
15
15
|
export interface ChooseLayersOptions extends HasMaps, HasUITarget {
|
|
16
16
|
/**
|
|
17
|
-
* Whether the user can choose multiple layers, or just one. Default is
|
|
18
|
-
* `false`.
|
|
17
|
+
* Whether the user can choose multiple layers, or just one. Default is `false`.
|
|
19
18
|
*/
|
|
20
19
|
allowMultiple?: boolean;
|
|
21
20
|
}
|
|
@@ -45,8 +45,7 @@ export interface RunPrintArgs {
|
|
|
45
45
|
*/
|
|
46
46
|
extent?: Extent;
|
|
47
47
|
/**
|
|
48
|
-
* The initial viewpoint of the 3D map(s). Defaults to the scene's current
|
|
49
|
-
* viewpoint.
|
|
48
|
+
* The initial viewpoint of the 3D map(s). Defaults to the scene's current viewpoint.
|
|
50
49
|
*/
|
|
51
50
|
viewpoint?: Viewpoint;
|
|
52
51
|
/**
|
|
@@ -127,8 +126,8 @@ export declare class PrintEvents extends EventRegistry {
|
|
|
127
126
|
*/
|
|
128
127
|
get printProgress(): Event<PrintProgressEventArgs>;
|
|
129
128
|
/**
|
|
130
|
-
* Raised when a print has finished running. Event arguments include
|
|
131
|
-
*
|
|
129
|
+
* Raised when a print has finished running. Event arguments include the
|
|
130
|
+
* print download URL.
|
|
132
131
|
*/
|
|
133
132
|
get printFinished(): Event<PrintFinishedEventArgs>;
|
|
134
133
|
/**
|
|
@@ -164,8 +164,7 @@ export interface FromGraphicsArgs {
|
|
|
164
164
|
*/
|
|
165
165
|
title?: string;
|
|
166
166
|
/**
|
|
167
|
-
* The feature source ID to use if the results are associated with a
|
|
168
|
-
* workflow.
|
|
167
|
+
* The feature source ID to use if the results are associated with a workflow.
|
|
169
168
|
*/
|
|
170
169
|
workflowItemId?: string;
|
|
171
170
|
}
|
|
@@ -244,8 +243,7 @@ export interface SetListCardSizeArgs {
|
|
|
244
243
|
results?: ModelRef;
|
|
245
244
|
}
|
|
246
245
|
/**
|
|
247
|
-
* Arguments for various commands that manipulate the current set of shown
|
|
248
|
-
* results.
|
|
246
|
+
* Arguments for various commands that manipulate the current set of shown results.
|
|
249
247
|
*/
|
|
250
248
|
export declare type ShowResultsArgs = Features | (UpdateResultsFeaturesArgs & {
|
|
251
249
|
/**
|
|
@@ -279,8 +277,7 @@ export declare class ResultsCommands extends CommandRegistry {
|
|
|
279
277
|
* Presents features to the user within any components that can display
|
|
280
278
|
* features, such as a feature list, feature table, or feature details
|
|
281
279
|
* component. The argument is the features to display, or an object
|
|
282
|
-
* specifying both features and the target results component to update (Web
|
|
283
|
-
* only).
|
|
280
|
+
* specifying both features and the target results component to update (Web only).
|
|
284
281
|
*/
|
|
285
282
|
get display(): Command<Features | UpdateResultsFeaturesArgs>;
|
|
286
283
|
/**
|
|
@@ -297,15 +294,13 @@ export declare class ResultsCommands extends CommandRegistry {
|
|
|
297
294
|
/**
|
|
298
295
|
* Presents feature details to the user within the feature-details
|
|
299
296
|
* component. The argument is the feature(s) to display, or an object
|
|
300
|
-
* specifying both features and the target results component to update (Web
|
|
301
|
-
* only).
|
|
297
|
+
* specifying both features and the target results component to update (Web only).
|
|
302
298
|
*/
|
|
303
299
|
get displayDetails(): Command<Features | UpdateResultsFeaturesArgs>;
|
|
304
300
|
/**
|
|
305
301
|
* Presents a feature summary to the user within the feature-summary
|
|
306
302
|
* component. The argument is the feature(s) to display, or an object
|
|
307
|
-
* specifying both features and the target results component to update (Web
|
|
308
|
-
* only).
|
|
303
|
+
* specifying both features and the target results component to update (Web only).
|
|
309
304
|
*
|
|
310
305
|
* @webOnly
|
|
311
306
|
*/
|
|
@@ -343,8 +338,7 @@ export declare class ResultsCommands extends CommandRegistry {
|
|
|
343
338
|
*/
|
|
344
339
|
get clearDetails(): Command;
|
|
345
340
|
/**
|
|
346
|
-
* Deactivates the feature details component that is displaying the given
|
|
347
|
-
* feature.
|
|
341
|
+
* Deactivates the feature details component that is displaying the given feature.
|
|
348
342
|
*
|
|
349
343
|
* @mobileOnly
|
|
350
344
|
*/
|
|
@@ -394,8 +388,7 @@ export declare class ResultsOperations extends OperationRegistry {
|
|
|
394
388
|
get convertToCsv(): Operation<ToCsvConversionArgs | Features, ConversionResult>;
|
|
395
389
|
/**
|
|
396
390
|
* Converts the provided Feature(s) to a XLSX file grouped by feature
|
|
397
|
-
* source. If there are multiple sources the XLSX(s) will be bundled in a
|
|
398
|
-
* zip file.
|
|
391
|
+
* source. If there are multiple sources the XLSX(s) will be bundled in a zip file.
|
|
399
392
|
*
|
|
400
393
|
* @webOnly
|
|
401
394
|
*/
|
|
@@ -433,8 +426,7 @@ export declare class ResultsOperations extends OperationRegistry {
|
|
|
433
426
|
*/
|
|
434
427
|
get fromXlsx(): Operation<FromXLSXConversionArgs | Blob | Blob[], Features>;
|
|
435
428
|
/**
|
|
436
|
-
* Converts provided GraphicsLike to Geocortex Features using any available
|
|
437
|
-
* metadata.
|
|
429
|
+
* Converts provided GraphicsLike to Geocortex Features using any available metadata.
|
|
438
430
|
*/
|
|
439
431
|
get fromGraphics(): Operation<FromGraphicsArgs, Features>;
|
|
440
432
|
/**
|
|
@@ -144,8 +144,8 @@ export interface MovePointArgs extends HasMaps {
|
|
|
144
144
|
partIndex?: number;
|
|
145
145
|
/**
|
|
146
146
|
* The new point that will replace the target point within an active sketch
|
|
147
|
-
* or edit geometry. If this property is defined, the distance property
|
|
148
|
-
*
|
|
147
|
+
* or edit geometry. If this property is defined, the distance property will
|
|
148
|
+
* be ignored.
|
|
149
149
|
*/
|
|
150
150
|
newPoint?: Point;
|
|
151
151
|
/**
|
|
@@ -207,19 +207,16 @@ export interface CaptureGeometryArgs {
|
|
|
207
207
|
*/
|
|
208
208
|
maps?: MapsLike;
|
|
209
209
|
/**
|
|
210
|
-
* The geometry/shape to use for sketching.
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
* automatically begin the freehand variation of the next included geometry
|
|
217
|
-
* type.
|
|
210
|
+
* The geometry/shape to use for sketching. * Multiple sketch tools are only
|
|
211
|
+
* supported by Geocortex Web. When multiple sketch tools are provided, the
|
|
212
|
+
* sketch will begin with the first one in the list. If "point" is the first
|
|
213
|
+
* of multiple options in the list, click actions will create points while
|
|
214
|
+
* click-and-drag actions will automatically begin the freehand variation of
|
|
215
|
+
* the next included geometry type.
|
|
218
216
|
*/
|
|
219
217
|
geometryType: SketchTool | SketchTool[];
|
|
220
218
|
/**
|
|
221
|
-
* An optional symbol to use. SymbolSets are not supported by Geocortex
|
|
222
|
-
* Mobile.
|
|
219
|
+
* An optional symbol to use. SymbolSets are not supported by Geocortex Mobile.
|
|
223
220
|
*/
|
|
224
221
|
symbol?: SymbolJson | SymbolSet;
|
|
225
222
|
/**
|
|
@@ -387,8 +384,7 @@ export interface StopGeometryEditArgs {
|
|
|
387
384
|
*/
|
|
388
385
|
maps: MapsLike;
|
|
389
386
|
/**
|
|
390
|
-
*
|
|
391
|
-
* if not set.
|
|
387
|
+
* Whether to validate the geometry before returning it. Defaults to true if not set.
|
|
392
388
|
*/
|
|
393
389
|
validateGeometry?: boolean;
|
|
394
390
|
}
|
|
@@ -444,9 +440,9 @@ export interface AddNodeToGeometryArgs extends HasMaps {
|
|
|
444
440
|
geometry: Geometry;
|
|
445
441
|
/**
|
|
446
442
|
* The type of geometry to create if the initial geometry is null. In
|
|
447
|
-
* Geocortex Mobile, this value must be 'polygon' or 'polyline'. In
|
|
448
|
-
* Web, this value may also be null if the point being added is
|
|
449
|
-
* be added to the active sketch.
|
|
443
|
+
* Geocortex Mobile, this value must be 'polygon' or 'polyline'. In
|
|
444
|
+
* Geocortex Web, this value may also be null if the point being added is
|
|
445
|
+
* intended to be added to the active sketch.
|
|
450
446
|
*/
|
|
451
447
|
geometryType: string;
|
|
452
448
|
/**
|
|
@@ -456,8 +452,8 @@ export interface AddNodeToGeometryArgs extends HasMaps {
|
|
|
456
452
|
*/
|
|
457
453
|
node: Geometry;
|
|
458
454
|
/**
|
|
459
|
-
* Indicates whether the new point should be added before or after the
|
|
460
|
-
* point in the sketch. Not supported by Geocortex Mobile.
|
|
455
|
+
* Indicates whether the new point should be added before or after the
|
|
456
|
+
* active point in the sketch. Not supported by Geocortex Mobile.
|
|
461
457
|
*/
|
|
462
458
|
nodeOrder?: AddNodeOrder;
|
|
463
459
|
}
|
|
@@ -494,8 +490,7 @@ export interface DeleteGeometryArgs extends HasMaps {
|
|
|
494
490
|
*/
|
|
495
491
|
export interface SetGeometryModeArgs extends HasMaps {
|
|
496
492
|
/**
|
|
497
|
-
* The geometry mode to switch to. Geocortex Mobile only supports "line" and
|
|
498
|
-
* "area".
|
|
493
|
+
* The geometry mode to switch to. Geocortex Mobile only supports "line" and "area".
|
|
499
494
|
*/
|
|
500
495
|
editorGeometryMode: EditorGeometryMode | SketchTool;
|
|
501
496
|
}
|
|
@@ -534,8 +529,7 @@ export interface GeometryEditorSettings {
|
|
|
534
529
|
*/
|
|
535
530
|
snappingEnabled?: boolean;
|
|
536
531
|
/**
|
|
537
|
-
* A value indicating whether bearing labels should be
|
|
538
|
-
* shown on the map.
|
|
532
|
+
* A value indicating whether bearing labels should be shown on the map.
|
|
539
533
|
*/
|
|
540
534
|
showBearings?: boolean;
|
|
541
535
|
/**
|
|
@@ -574,8 +568,7 @@ export declare type PointOffset = "before" | "after";
|
|
|
574
568
|
*/
|
|
575
569
|
export interface GetAdjacentPointArgs extends HasMaps {
|
|
576
570
|
/**
|
|
577
|
-
* A point geometry that represents a vertex within an active editing
|
|
578
|
-
* graphic.
|
|
571
|
+
* A point geometry that represents a vertex within an active editing graphic.
|
|
579
572
|
*/
|
|
580
573
|
referencePoint: Point;
|
|
581
574
|
/**
|
|
@@ -608,8 +601,7 @@ export interface SetConstraintsArgs extends HasMaps {
|
|
|
608
601
|
* Indicates whether constraints will be automatically cleared after a
|
|
609
602
|
* vertex is added or updated. If not set (value is null), then the value
|
|
610
603
|
* will remain unchanged with this operation. If the value has never been
|
|
611
|
-
* set, the default is false. Remains unchanged until set to a different
|
|
612
|
-
* value.
|
|
604
|
+
* set, the default is false. Remains unchanged until set to a different value.
|
|
613
605
|
*/
|
|
614
606
|
autoClear?: boolean;
|
|
615
607
|
/**
|
|
@@ -625,7 +617,7 @@ export interface SetConstraintsArgs extends HasMaps {
|
|
|
625
617
|
/**
|
|
626
618
|
* The geodetic curve type used when calculating the new point. Only applies
|
|
627
619
|
* when geodetic is set to true. Defaults to geodesic.
|
|
628
|
-
|
|
620
|
+
*/
|
|
629
621
|
geodeticCurveType?: GeodeticCurveType;
|
|
630
622
|
}
|
|
631
623
|
/**
|
|
@@ -668,7 +660,6 @@ export declare class SketchingOperations extends OperationRegistry {
|
|
|
668
660
|
* with the command chain, but only the map is required for this operation.
|
|
669
661
|
*
|
|
670
662
|
* @webOnly
|
|
671
|
-
*
|
|
672
663
|
*/
|
|
673
664
|
get moveGeometry(): Operation<MoveGeometryArgs, GeometryOperationBase>;
|
|
674
665
|
/**
|
|
@@ -678,7 +669,6 @@ export declare class SketchingOperations extends OperationRegistry {
|
|
|
678
669
|
* with the command chain, but they are not required for this operation.
|
|
679
670
|
*
|
|
680
671
|
* @webOnly
|
|
681
|
-
*
|
|
682
672
|
*/
|
|
683
673
|
get scaleGeometry(): Operation<ScaleGeometryArgs, GeometryOperationBase>;
|
|
684
674
|
/**
|
|
@@ -698,8 +688,7 @@ export declare class SketchingOperations extends OperationRegistry {
|
|
|
698
688
|
get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
|
|
699
689
|
/**
|
|
700
690
|
* Deprecated - Mobile users should rather use "geometry.add-point"; Web
|
|
701
|
-
* users should use "sketching.add-point" or "sketching.insert-point"
|
|
702
|
-
* instead.
|
|
691
|
+
* users should use "sketching.add-point" or "sketching.insert-point" instead.
|
|
703
692
|
*
|
|
704
693
|
* @deprecated
|
|
705
694
|
*/
|
|
@@ -718,8 +707,7 @@ export declare class SketchingOperations extends OperationRegistry {
|
|
|
718
707
|
*/
|
|
719
708
|
get getActiveNode(): Operation<Maps, GetActivePointsResult>;
|
|
720
709
|
/**
|
|
721
|
-
* Returns the active point graphics of the active sketch or edit session on
|
|
722
|
-
* a map.
|
|
710
|
+
* Returns the active point graphics of the active sketch or edit session on a map.
|
|
723
711
|
*
|
|
724
712
|
* @webOnly
|
|
725
713
|
*/
|
|
@@ -774,8 +762,8 @@ export declare class SketchingCommands extends CommandRegistry {
|
|
|
774
762
|
/**
|
|
775
763
|
* Sets a point at the user's current location while editing a geometry. In
|
|
776
764
|
* this context, "set" means to either add a point at the current location,
|
|
777
|
-
* or update the currently selected point to be the user's current
|
|
778
|
-
*
|
|
765
|
+
* or update the currently selected point to be the user's current location,
|
|
766
|
+
* depending on what edit mode the user is in.
|
|
779
767
|
*
|
|
780
768
|
* @mobileOnly
|
|
781
769
|
*/
|
|
@@ -784,8 +772,7 @@ export declare class SketchingCommands extends CommandRegistry {
|
|
|
784
772
|
* If a point is supplied while a sketching or editing operation is active,
|
|
785
773
|
* the vertex at that point will be deleted from the current geometry. If no
|
|
786
774
|
* point is supplied, any active points in the session will be deleted. If
|
|
787
|
-
* there are no active points in the session, the entire geometry will be
|
|
788
|
-
* deleted.
|
|
775
|
+
* there are no active points in the session, the entire geometry will be deleted.
|
|
789
776
|
*/
|
|
790
777
|
get delete(): Command<void | DeleteGeometryArgs>;
|
|
791
778
|
/**
|
|
@@ -868,8 +855,8 @@ export declare class SketchingCommands extends CommandRegistry {
|
|
|
868
855
|
*/
|
|
869
856
|
get addPoint(): Command<AddPointArgs>;
|
|
870
857
|
/**
|
|
871
|
-
* Starts streaming: recording your location at regular intervals and
|
|
872
|
-
*
|
|
858
|
+
* Starts streaming: recording your location at regular intervals and adding
|
|
859
|
+
* the collected points to the currently active geometry editor.
|
|
873
860
|
*
|
|
874
861
|
* @mobileOnly
|
|
875
862
|
*/
|