@vertigis/viewer-spec 50.2.0 → 50.4.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/web/ResultsServiceModelProperties.d.ts +12 -0
- package/app-config/web/ResultsServiceModelProperties.js +1 -0
- package/layout/schema/layout-common.xsd +22 -2
- package/layout/schema/layout-web.xsd +22 -2
- package/messaging/registry/geolocation.d.ts +5 -5
- package/messaging/registry/geometry.d.ts +3 -4
- package/messaging/registry/map.d.ts +2 -2
- package/messaging/registry/offline.d.ts +29 -4
- package/messaging/registry/results.d.ts +43 -4
- package/messaging/registry/results.js +1 -1
- package/messaging/registry/sketching.d.ts +5 -6
- package/messaging/schema/common-action.schema.json +23 -8
- package/messaging/schema/mobile-action.schema.json +65 -14
- package/messaging/schema/web-action.schema.json +75 -8
- package/messaging/schema/web-event.schema.json +23 -0
- package/package.json +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { ComponentModelProperties } from "./ComponentModelProperties.js";
|
|
2
|
+
import type { FeatureListProperties } from "./FeatureListProperties.js";
|
|
3
|
+
/**
|
|
4
|
+
* @inheritdoc
|
|
5
|
+
*/
|
|
6
|
+
export interface ResultsServiceModelProperties extends ComponentModelProperties {
|
|
7
|
+
/**
|
|
8
|
+
* The name results list stored in the service. This property is only
|
|
9
|
+
* serialized into saved projects.
|
|
10
|
+
*/
|
|
11
|
+
results?: Record<string, FeatureListProperties>;
|
|
12
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export{};
|
|
@@ -698,7 +698,17 @@
|
|
|
698
698
|
</annotation>
|
|
699
699
|
<complexType>
|
|
700
700
|
<complexContent>
|
|
701
|
-
<extension base="tns:Component"
|
|
701
|
+
<extension base="tns:Component">
|
|
702
|
+
<attribute name="showStarControls" type="boolean" default="false">
|
|
703
|
+
<annotation>
|
|
704
|
+
<documentation xml:lang="en">
|
|
705
|
+
Whether or not the starred feature icons and
|
|
706
|
+
functionality should be included. Defaults to
|
|
707
|
+
false. Web only.
|
|
708
|
+
</documentation>
|
|
709
|
+
</annotation>
|
|
710
|
+
</attribute>
|
|
711
|
+
</extension>
|
|
702
712
|
</complexContent>
|
|
703
713
|
</complexType>
|
|
704
714
|
</element>
|
|
@@ -858,7 +868,17 @@
|
|
|
858
868
|
</annotation>
|
|
859
869
|
<complexType>
|
|
860
870
|
<complexContent>
|
|
861
|
-
<extension base="tns:Component"
|
|
871
|
+
<extension base="tns:Component">
|
|
872
|
+
<attribute name="showStarControls" type="boolean" default="false">
|
|
873
|
+
<annotation>
|
|
874
|
+
<documentation xml:lang="en">
|
|
875
|
+
Whether or not the starred feature icons and
|
|
876
|
+
functionality should be included. Defaults to
|
|
877
|
+
false. Web only
|
|
878
|
+
</documentation>
|
|
879
|
+
</annotation>
|
|
880
|
+
</attribute>
|
|
881
|
+
</extension>
|
|
862
882
|
</complexContent>
|
|
863
883
|
</complexType>
|
|
864
884
|
</element>
|
|
@@ -44,7 +44,17 @@
|
|
|
44
44
|
</annotation>
|
|
45
45
|
<complexType>
|
|
46
46
|
<complexContent>
|
|
47
|
-
<extension base="base:Component"
|
|
47
|
+
<extension base="base:Component">
|
|
48
|
+
<attribute name="showStarControls" type="boolean" default="false">
|
|
49
|
+
<annotation>
|
|
50
|
+
<documentation xml:lang="en">
|
|
51
|
+
Whether or not the starred feature icons and
|
|
52
|
+
functionality should be included. Defaults to
|
|
53
|
+
false.
|
|
54
|
+
</documentation>
|
|
55
|
+
</annotation>
|
|
56
|
+
</attribute>
|
|
57
|
+
</extension>
|
|
48
58
|
</complexContent>
|
|
49
59
|
</complexType>
|
|
50
60
|
</element>
|
|
@@ -197,7 +207,17 @@
|
|
|
197
207
|
</annotation>
|
|
198
208
|
<complexType>
|
|
199
209
|
<complexContent>
|
|
200
|
-
<extension base="base:Component"
|
|
210
|
+
<extension base="base:Component">
|
|
211
|
+
<attribute name="showStarControls" type="boolean" default="false">
|
|
212
|
+
<annotation>
|
|
213
|
+
<documentation xml:lang="en">
|
|
214
|
+
Whether or not the starred feature icons and
|
|
215
|
+
functionality should be included. Defaults to
|
|
216
|
+
false.
|
|
217
|
+
</documentation>
|
|
218
|
+
</annotation>
|
|
219
|
+
</attribute>
|
|
220
|
+
</extension>
|
|
201
221
|
</complexContent>
|
|
202
222
|
</complexType>
|
|
203
223
|
</element>
|
|
@@ -157,14 +157,14 @@ export interface GetTransformationArgs {
|
|
|
157
157
|
*/
|
|
158
158
|
inputSpatialReference?: SpatialReference;
|
|
159
159
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
160
|
+
* The desired output spatial reference of the transformations. For example,
|
|
161
|
+
* the spatial reference of the map. If unspecified, the spatial reference
|
|
162
|
+
* of the first available map will be used.
|
|
163
163
|
*/
|
|
164
164
|
outputSpatialReference?: SpatialReference;
|
|
165
165
|
/**
|
|
166
|
-
*
|
|
167
|
-
*
|
|
166
|
+
* The area of interest. If provided, this will be used to order the list of
|
|
167
|
+
* valid transformations in order of best-fit.
|
|
168
168
|
*/
|
|
169
169
|
area?: Geometry;
|
|
170
170
|
}
|
|
@@ -152,13 +152,12 @@ export interface CalculatePointArgs {
|
|
|
152
152
|
*/
|
|
153
153
|
angle?: number;
|
|
154
154
|
/**
|
|
155
|
-
*
|
|
156
|
-
* geodetic or planar. Defaults to true.
|
|
155
|
+
* Whether the distance calculations will be geodetic or planar. Defaults to true.
|
|
157
156
|
*/
|
|
158
157
|
geodetic?: boolean;
|
|
159
158
|
/**
|
|
160
|
-
*
|
|
161
|
-
*
|
|
159
|
+
* The geodetic curve type used when calculating the new point. Only applies
|
|
160
|
+
* when 'geodetic' is true. Defaults to 'geodesic'.
|
|
162
161
|
*/
|
|
163
162
|
geodeticCurveType: GeodeticCurveType;
|
|
164
163
|
}
|
|
@@ -595,8 +595,8 @@ export interface StartSketchArgs {
|
|
|
595
595
|
*/
|
|
596
596
|
bufferSize: number;
|
|
597
597
|
/**
|
|
598
|
-
*
|
|
599
|
-
*
|
|
598
|
+
* Whether the previous geometry editor settings should be restored after
|
|
599
|
+
* this sketch is stopped.
|
|
600
600
|
*/
|
|
601
601
|
retainEditorSettings: boolean;
|
|
602
602
|
/**
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
/// <reference types="dotnet-bcl" />
|
|
2
|
+
import type Geometry from "@arcgis/core/geometry/Geometry.js";
|
|
2
3
|
import type FeatureLayer from "@arcgis/core/layers/FeatureLayer";
|
|
3
4
|
import type Layer from "@arcgis/core/layers/Layer";
|
|
4
5
|
import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
|
|
@@ -113,11 +114,35 @@ export interface OfflineAreaBase {
|
|
|
113
114
|
export interface CustomOfflineArea {
|
|
114
115
|
}
|
|
115
116
|
/**
|
|
116
|
-
*
|
|
117
|
-
* `VertiGIS.Mobile.Infrastructure.Offline.CustomOfflineAreaDetails` in the
|
|
118
|
-
* VertiGIS.Mobile SDK.
|
|
117
|
+
* Defines the details for the creation of a custom offline map area.
|
|
119
118
|
*/
|
|
120
119
|
export interface CustomOfflineAreaDetails {
|
|
120
|
+
/**
|
|
121
|
+
* The geometry defining this map area.
|
|
122
|
+
*/
|
|
123
|
+
areaOfInterest: Geometry;
|
|
124
|
+
/**
|
|
125
|
+
* The minimum scale for the map.
|
|
126
|
+
*/
|
|
127
|
+
minScale: number;
|
|
128
|
+
/**
|
|
129
|
+
* The maximum scale for the map.
|
|
130
|
+
*/
|
|
131
|
+
maxScale: number;
|
|
132
|
+
/**
|
|
133
|
+
* Whether to include feature attachments when downloading this map area.
|
|
134
|
+
* Defaults to false.
|
|
135
|
+
*/
|
|
136
|
+
includeAttachments?: boolean;
|
|
137
|
+
/**
|
|
138
|
+
* The name of a tile package to use as a basemap.
|
|
139
|
+
*/
|
|
140
|
+
basemapTilePackage?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Whether feature layer definition expressions are used when taking feature
|
|
143
|
+
* layers and tables offline. Defaults to false.
|
|
144
|
+
*/
|
|
145
|
+
isDefinitionExpressionFilterEnabled?: boolean;
|
|
121
146
|
}
|
|
122
147
|
/**
|
|
123
148
|
* Corresponds to `VertiGIS.Mobile.Infrastructure.Offline.OfflineAreaStatus` in
|
|
@@ -156,7 +181,7 @@ export interface LayerEdits {
|
|
|
156
181
|
*/
|
|
157
182
|
export interface OfflineOperationResult {
|
|
158
183
|
/**
|
|
159
|
-
*
|
|
184
|
+
* Whether or not the operation was successful.
|
|
160
185
|
*/
|
|
161
186
|
success: boolean;
|
|
162
187
|
/**
|
|
@@ -18,16 +18,36 @@ import type { Operation } from "../Operation.js";
|
|
|
18
18
|
import { OperationRegistry } from "../OperationRegistry.js";
|
|
19
19
|
import type { Blob, Features, FeaturesLike, GraphicsLike, HasFeatures, MapsLike, ModelRef } from "../common.js";
|
|
20
20
|
import type { VisualElement } from "../mobile.js";
|
|
21
|
+
/**
|
|
22
|
+
* Well known Results Set Ids.
|
|
23
|
+
*/
|
|
24
|
+
export declare enum KnownResultSetIds {
|
|
25
|
+
STARRED = "vgs-starred"
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Arguments for various commands that target a result set of features.
|
|
29
|
+
*/
|
|
30
|
+
export interface TargetsResultsSetArgs {
|
|
31
|
+
/**
|
|
32
|
+
* If specified the results will be updated in the named results set only.
|
|
33
|
+
* Results sets with the prefix 'vgs' are reserved for system use and should
|
|
34
|
+
* not be used unless you are intentionally targeting a well known results
|
|
35
|
+
* set such as the 'vgs-starred' results.
|
|
36
|
+
*
|
|
37
|
+
* @webOnly
|
|
38
|
+
*/
|
|
39
|
+
resultsSetId?: KnownResultSetIds | string;
|
|
40
|
+
}
|
|
21
41
|
/**
|
|
22
42
|
* Arguments for various commands that affect a result component's features.
|
|
23
43
|
*/
|
|
24
|
-
export interface UpdateResultsFeaturesArgs extends HasFeatures {
|
|
44
|
+
export interface UpdateResultsFeaturesArgs extends TargetsResultsSetArgs, HasFeatures {
|
|
25
45
|
/**
|
|
26
46
|
* The result component to update, referenced by results model or its ID.
|
|
27
47
|
*
|
|
28
48
|
* @webOnly
|
|
29
49
|
*/
|
|
30
|
-
results
|
|
50
|
+
results?: ModelRef;
|
|
31
51
|
}
|
|
32
52
|
/**
|
|
33
53
|
* Arguments for the "results.convert-to-csv" operation.
|
|
@@ -295,6 +315,13 @@ export interface FeatureDetailsEvent {
|
|
|
295
315
|
feature: Feature;
|
|
296
316
|
}
|
|
297
317
|
export declare class ResultsCommands extends CommandRegistry {
|
|
318
|
+
/**
|
|
319
|
+
* Activates the current set of results component(s), which is set via
|
|
320
|
+
* results.set-display-components.
|
|
321
|
+
*
|
|
322
|
+
* @webOnly
|
|
323
|
+
*/
|
|
324
|
+
get activateDisplayComponents(): Command<void>;
|
|
298
325
|
/**
|
|
299
326
|
* Presents features to the user within any components that can display
|
|
300
327
|
* features, such as a feature list, feature table, or feature details
|
|
@@ -352,7 +379,7 @@ export declare class ResultsCommands extends CommandRegistry {
|
|
|
352
379
|
* a component model or model ID is given, then only the specified component
|
|
353
380
|
* is cleared (Web only).
|
|
354
381
|
*/
|
|
355
|
-
get clear(): Command<ModelRef | void>;
|
|
382
|
+
get clear(): Command<ModelRef | TargetsResultsSetArgs | void>;
|
|
356
383
|
/**
|
|
357
384
|
* Clears the feature details so that no feature data is shown.
|
|
358
385
|
*
|
|
@@ -393,6 +420,12 @@ export declare class ResultsCommands extends CommandRegistry {
|
|
|
393
420
|
get setListCardSize(): Command<CardSize | SetListCardSizeArgs>;
|
|
394
421
|
}
|
|
395
422
|
export declare class ResultsEvents extends EventRegistry {
|
|
423
|
+
/**
|
|
424
|
+
* Raised when results are added or removed to a named results set.
|
|
425
|
+
*
|
|
426
|
+
* @webOnly
|
|
427
|
+
*/
|
|
428
|
+
get changed(): Event<TargetsResultsSetArgs>;
|
|
396
429
|
/**
|
|
397
430
|
* Raised when results are displayed.
|
|
398
431
|
*
|
|
@@ -419,6 +452,12 @@ export declare class ResultsEvents extends EventRegistry {
|
|
|
419
452
|
get relatedDetailsShown(): Event<FeatureDetailsEvent>;
|
|
420
453
|
}
|
|
421
454
|
export declare class ResultsOperations extends OperationRegistry {
|
|
455
|
+
/**
|
|
456
|
+
* Check if features are contained in the specified results.
|
|
457
|
+
*
|
|
458
|
+
* @webOnly
|
|
459
|
+
*/
|
|
460
|
+
get contains(): Operation<TargetsResultsSetArgs & HasFeatures, boolean[]>;
|
|
422
461
|
/**
|
|
423
462
|
* Converts the provided Feature(s) to a CSV file grouped by feature source.
|
|
424
463
|
* If there are multiple sources the CSV(s) will be bundled in a zip file.
|
|
@@ -479,7 +518,7 @@ export declare class ResultsOperations extends OperationRegistry {
|
|
|
479
518
|
*
|
|
480
519
|
* @webOnly
|
|
481
520
|
*/
|
|
482
|
-
get getFeatures(): Operation<ModelRef | void, Features>;
|
|
521
|
+
get getFeatures(): Operation<ModelRef | TargetsResultsSetArgs | void, Features>;
|
|
483
522
|
/**
|
|
484
523
|
* Filters down a set of results using an SQL 'where' clause and/or an
|
|
485
524
|
* intersecting geometry.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export class ResultsCommands extends CommandRegistry{get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends EventRegistry{get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends OperationRegistry{get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
|
|
1
|
+
import{CommandRegistry}from"../CommandRegistry.js";import{EventRegistry}from"../EventRegistry.js";import{OperationRegistry}from"../OperationRegistry.js";export var KnownResultSetIds;!function(e){e.STARRED="vgs-starred"}(KnownResultSetIds||(KnownResultSetIds={}));export class ResultsCommands extends CommandRegistry{get activateDisplayComponents(){return this._messages.command("results.activate-display-components")}get display(){return this._messages.command("results.display")}get setDisplayComponents(){return this._messages.command("results.set-display-components")}get displayDetails(){return this._messages.command("results.display-details")}get displaySummary(){return this._messages.command("results.display-summary")}get displayNewDetails(){return this._messages.command("results.display-new-details")}get add(){return this._messages.command("results.add")}get intersect(){return this._messages.command("results.intersect")}get remove(){return this._messages.command("results.remove")}get clear(){return this._messages.command("results.clear")}get clearDetails(){return this._messages.command("results.clear-details")}get hideDetails(){return this._messages.command("results.hide-details")}get openAttachment(){return this._messages.command("results.open-attachment")}get refresh(){return this._messages.command("results.refresh")}get setListViewMode(){return this._messages.command("results.set-list-view-mode")}get setListCardSize(){return this._messages.command("results.set-list-card-size")}}export class ResultsEvents extends EventRegistry{get changed(){return this._messages.event("results.changed")}get displayed(){return this._messages.event("results.displayed")}get attachmentOpened(){return this._messages.event("results.attachment-opened")}get detailsShown(){return this._messages.event("results.details-shown")}get relatedDetailsShown(){return this._messages.event("results.related-details-shown")}}export class ResultsOperations extends OperationRegistry{get contains(){return this._messages.operation("results.contains")}get convertToCsv(){return this._messages.operation("results.convert-to-csv")}get convertToXlsx(){return this._messages.operation("results.convert-to-xlsx")}get convertToShapefile(){return this._messages.operation("results.convert-to-shapefile")}get convertToLayers(){return this._messages.operation("results.convert-to-layers")}get fromCsv(){return this._messages.operation("results.from-csv")}get fromShapefile(){return this._messages.operation("results.from-shapefile")}get fromXlsx(){return this._messages.operation("results.from-xlsx")}get fromGraphics(){return this._messages.operation("results.from-graphics")}get toGraphics(){return this._messages.operation("results.to-graphics")}get getFeatures(){return this._messages.operation("results.get-features")}get filter(){return this._messages.operation("results.filter")}}
|
|
@@ -533,11 +533,11 @@ export declare type EditorInteractionMode = "centerCrosshairMode" | "pointerMode
|
|
|
533
533
|
*/
|
|
534
534
|
export interface GeometryEditorSettings {
|
|
535
535
|
/**
|
|
536
|
-
*
|
|
536
|
+
* Whether snapping should be enabled.
|
|
537
537
|
*/
|
|
538
538
|
snappingEnabled?: boolean;
|
|
539
539
|
/**
|
|
540
|
-
*
|
|
540
|
+
* Whether bearing labels should be shown on the map.
|
|
541
541
|
*/
|
|
542
542
|
showBearings?: boolean;
|
|
543
543
|
/**
|
|
@@ -549,16 +549,15 @@ export interface GeometryEditorSettings {
|
|
|
549
549
|
*/
|
|
550
550
|
editorInteractionMode?: EditorInteractionMode;
|
|
551
551
|
/**
|
|
552
|
-
*
|
|
552
|
+
* Whether the sketch is using freehand or segment sketching.
|
|
553
553
|
*/
|
|
554
554
|
freehand?: boolean;
|
|
555
555
|
/**
|
|
556
|
-
*
|
|
556
|
+
* Whether the sketch should stop when double clicking.
|
|
557
557
|
*/
|
|
558
558
|
finishOnDoubleClick?: boolean;
|
|
559
559
|
/**
|
|
560
|
-
*
|
|
561
|
-
* another sketch is activated.
|
|
560
|
+
* Whether the sketch should commit its geometry if another sketch is activated.
|
|
562
561
|
*/
|
|
563
562
|
finishIfInterrupted?: boolean;
|
|
564
563
|
}
|
|
@@ -1411,23 +1411,23 @@
|
|
|
1411
1411
|
"description": "The editor interaction mode."
|
|
1412
1412
|
},
|
|
1413
1413
|
"finishIfInterrupted": {
|
|
1414
|
-
"description": "
|
|
1414
|
+
"description": "Whether the sketch should commit its geometry if another sketch is activated.",
|
|
1415
1415
|
"type": "boolean"
|
|
1416
1416
|
},
|
|
1417
1417
|
"finishOnDoubleClick": {
|
|
1418
|
-
"description": "
|
|
1418
|
+
"description": "Whether the sketch should stop when double clicking.",
|
|
1419
1419
|
"type": "boolean"
|
|
1420
1420
|
},
|
|
1421
1421
|
"freehand": {
|
|
1422
|
-
"description": "
|
|
1422
|
+
"description": "Whether the sketch is using freehand or segment sketching.",
|
|
1423
1423
|
"type": "boolean"
|
|
1424
1424
|
},
|
|
1425
1425
|
"showBearings": {
|
|
1426
|
-
"description": "
|
|
1426
|
+
"description": "Whether bearing labels should be shown on the map.",
|
|
1427
1427
|
"type": "boolean"
|
|
1428
1428
|
},
|
|
1429
1429
|
"snappingEnabled": {
|
|
1430
|
-
"description": "
|
|
1430
|
+
"description": "Whether snapping should be enabled.",
|
|
1431
1431
|
"type": "boolean"
|
|
1432
1432
|
}
|
|
1433
1433
|
},
|
|
@@ -2364,6 +2364,17 @@
|
|
|
2364
2364
|
},
|
|
2365
2365
|
"type": "object"
|
|
2366
2366
|
},
|
|
2367
|
+
"TargetsResultsSetArgs": {
|
|
2368
|
+
"additionalProperties": false,
|
|
2369
|
+
"description": "Arguments for various commands that target a result set of features.",
|
|
2370
|
+
"properties": {
|
|
2371
|
+
"resultsSetId": {
|
|
2372
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
2373
|
+
"type": "string"
|
|
2374
|
+
}
|
|
2375
|
+
},
|
|
2376
|
+
"type": "object"
|
|
2377
|
+
},
|
|
2367
2378
|
"TrackCustomEventArgs": {
|
|
2368
2379
|
"additionalProperties": false,
|
|
2369
2380
|
"description": "Arguments for the 'studio-analytics.track-custom-event' command.",
|
|
@@ -2447,11 +2458,12 @@
|
|
|
2447
2458
|
"results": {
|
|
2448
2459
|
"$ref": "#/definitions/ModelRef",
|
|
2449
2460
|
"description": "The result component to update, referenced by results model or its ID."
|
|
2461
|
+
},
|
|
2462
|
+
"resultsSetId": {
|
|
2463
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
2464
|
+
"type": "string"
|
|
2450
2465
|
}
|
|
2451
2466
|
},
|
|
2452
|
-
"required": [
|
|
2453
|
-
"results"
|
|
2454
|
-
],
|
|
2455
2467
|
"type": "object"
|
|
2456
2468
|
},
|
|
2457
2469
|
"WebAddAttachmentArgs": {
|
|
@@ -12135,6 +12147,9 @@
|
|
|
12135
12147
|
{
|
|
12136
12148
|
"$ref": "#/definitions/Model"
|
|
12137
12149
|
},
|
|
12150
|
+
{
|
|
12151
|
+
"$ref": "#/definitions/TargetsResultsSetArgs"
|
|
12152
|
+
},
|
|
12138
12153
|
{
|
|
12139
12154
|
"type": [
|
|
12140
12155
|
"string",
|
|
@@ -674,12 +674,12 @@
|
|
|
674
674
|
"type": "number"
|
|
675
675
|
},
|
|
676
676
|
"geodetic": {
|
|
677
|
-
"description": "
|
|
677
|
+
"description": "Whether the distance calculations will be geodetic or planar. Defaults to true.",
|
|
678
678
|
"type": "boolean"
|
|
679
679
|
},
|
|
680
680
|
"geodeticCurveType": {
|
|
681
681
|
"$ref": "#/definitions/GeodeticCurveType",
|
|
682
|
-
"description": "
|
|
682
|
+
"description": "The geodetic curve type used when calculating the new point. Only applies when 'geodetic' is true. Defaults to 'geodesic'."
|
|
683
683
|
},
|
|
684
684
|
"offset": {
|
|
685
685
|
"description": "The offset that will be used to calculate the new point. The 'offset' corresponds to the distance perpendicularly away from the reference line. Positive values will result in a point to the right of the reference line, negative values will be to the left. Exactly one of 'offset' and 'angle' must be set.",
|
|
@@ -945,6 +945,42 @@
|
|
|
945
945
|
],
|
|
946
946
|
"type": "object"
|
|
947
947
|
},
|
|
948
|
+
"CustomOfflineAreaDetails": {
|
|
949
|
+
"additionalProperties": false,
|
|
950
|
+
"description": "Defines the details for the creation of a custom offline map area.",
|
|
951
|
+
"properties": {
|
|
952
|
+
"areaOfInterest": {
|
|
953
|
+
"$ref": "#/definitions/esri.Geometry",
|
|
954
|
+
"description": "The geometry defining this map area."
|
|
955
|
+
},
|
|
956
|
+
"basemapTilePackage": {
|
|
957
|
+
"description": "The name of a tile package to use as a basemap.",
|
|
958
|
+
"type": "string"
|
|
959
|
+
},
|
|
960
|
+
"includeAttachments": {
|
|
961
|
+
"description": "Whether to include feature attachments when downloading this map area. Defaults to false.",
|
|
962
|
+
"type": "boolean"
|
|
963
|
+
},
|
|
964
|
+
"isDefinitionExpressionFilterEnabled": {
|
|
965
|
+
"description": "Whether feature layer definition expressions are used when taking feature layers and tables offline. Defaults to false.",
|
|
966
|
+
"type": "boolean"
|
|
967
|
+
},
|
|
968
|
+
"maxScale": {
|
|
969
|
+
"description": "The maximum scale for the map.",
|
|
970
|
+
"type": "number"
|
|
971
|
+
},
|
|
972
|
+
"minScale": {
|
|
973
|
+
"description": "The minimum scale for the map.",
|
|
974
|
+
"type": "number"
|
|
975
|
+
}
|
|
976
|
+
},
|
|
977
|
+
"required": [
|
|
978
|
+
"areaOfInterest",
|
|
979
|
+
"maxScale",
|
|
980
|
+
"minScale"
|
|
981
|
+
],
|
|
982
|
+
"type": "object"
|
|
983
|
+
},
|
|
948
984
|
"DeleteAttachmentArgs": {
|
|
949
985
|
"additionalProperties": false,
|
|
950
986
|
"description": "Arguments for the \"edit.delete-attachment\" command.",
|
|
@@ -1686,23 +1722,23 @@
|
|
|
1686
1722
|
"description": "The editor interaction mode."
|
|
1687
1723
|
},
|
|
1688
1724
|
"finishIfInterrupted": {
|
|
1689
|
-
"description": "
|
|
1725
|
+
"description": "Whether the sketch should commit its geometry if another sketch is activated.",
|
|
1690
1726
|
"type": "boolean"
|
|
1691
1727
|
},
|
|
1692
1728
|
"finishOnDoubleClick": {
|
|
1693
|
-
"description": "
|
|
1729
|
+
"description": "Whether the sketch should stop when double clicking.",
|
|
1694
1730
|
"type": "boolean"
|
|
1695
1731
|
},
|
|
1696
1732
|
"freehand": {
|
|
1697
|
-
"description": "
|
|
1733
|
+
"description": "Whether the sketch is using freehand or segment sketching.",
|
|
1698
1734
|
"type": "boolean"
|
|
1699
1735
|
},
|
|
1700
1736
|
"showBearings": {
|
|
1701
|
-
"description": "
|
|
1737
|
+
"description": "Whether bearing labels should be shown on the map.",
|
|
1702
1738
|
"type": "boolean"
|
|
1703
1739
|
},
|
|
1704
1740
|
"snappingEnabled": {
|
|
1705
|
-
"description": "
|
|
1741
|
+
"description": "Whether snapping should be enabled.",
|
|
1706
1742
|
"type": "boolean"
|
|
1707
1743
|
}
|
|
1708
1744
|
},
|
|
@@ -1848,7 +1884,7 @@
|
|
|
1848
1884
|
"properties": {
|
|
1849
1885
|
"area": {
|
|
1850
1886
|
"$ref": "#/definitions/esri.Geometry",
|
|
1851
|
-
"description": "
|
|
1887
|
+
"description": "The area of interest. If provided, this will be used to order the list of valid transformations in order of best-fit."
|
|
1852
1888
|
},
|
|
1853
1889
|
"inputSpatialReference": {
|
|
1854
1890
|
"$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
|
|
@@ -1856,7 +1892,7 @@
|
|
|
1856
1892
|
},
|
|
1857
1893
|
"outputSpatialReference": {
|
|
1858
1894
|
"$ref": "#/definitions/esri.rest-api.SpatialReference.SpatialReference",
|
|
1859
|
-
"description": "
|
|
1895
|
+
"description": "The desired output spatial reference of the transformations. For example, the spatial reference of the map. If unspecified, the spatial reference of the first available map will be used."
|
|
1860
1896
|
}
|
|
1861
1897
|
},
|
|
1862
1898
|
"type": "object"
|
|
@@ -2351,7 +2387,7 @@
|
|
|
2351
2387
|
"type": "string"
|
|
2352
2388
|
},
|
|
2353
2389
|
"success": {
|
|
2354
|
-
"description": "
|
|
2390
|
+
"description": "Whether or not the operation was successful.",
|
|
2355
2391
|
"type": "boolean"
|
|
2356
2392
|
},
|
|
2357
2393
|
"syncLayerErrors": {
|
|
@@ -3075,7 +3111,7 @@
|
|
|
3075
3111
|
"type": "string"
|
|
3076
3112
|
},
|
|
3077
3113
|
"retainEditorSettings": {
|
|
3078
|
-
"description": "
|
|
3114
|
+
"description": "Whether the previous geometry editor settings should be restored after this sketch is stopped.",
|
|
3079
3115
|
"type": "boolean"
|
|
3080
3116
|
},
|
|
3081
3117
|
"symbol": {
|
|
@@ -3257,6 +3293,17 @@
|
|
|
3257
3293
|
},
|
|
3258
3294
|
"type": "object"
|
|
3259
3295
|
},
|
|
3296
|
+
"TargetsResultsSetArgs": {
|
|
3297
|
+
"additionalProperties": false,
|
|
3298
|
+
"description": "Arguments for various commands that target a result set of features.",
|
|
3299
|
+
"properties": {
|
|
3300
|
+
"resultsSetId": {
|
|
3301
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
3302
|
+
"type": "string"
|
|
3303
|
+
}
|
|
3304
|
+
},
|
|
3305
|
+
"type": "object"
|
|
3306
|
+
},
|
|
3260
3307
|
"TrackCustomEventArgs": {
|
|
3261
3308
|
"additionalProperties": false,
|
|
3262
3309
|
"description": "Arguments for the 'studio-analytics.track-custom-event' command.",
|
|
@@ -3340,11 +3387,12 @@
|
|
|
3340
3387
|
"results": {
|
|
3341
3388
|
"$ref": "#/definitions/ModelRef",
|
|
3342
3389
|
"description": "The result component to update, referenced by results model or its ID."
|
|
3390
|
+
},
|
|
3391
|
+
"resultsSetId": {
|
|
3392
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
3393
|
+
"type": "string"
|
|
3343
3394
|
}
|
|
3344
3395
|
},
|
|
3345
|
-
"required": [
|
|
3346
|
-
"results"
|
|
3347
|
-
],
|
|
3348
3396
|
"type": "object"
|
|
3349
3397
|
},
|
|
3350
3398
|
"WebAddAttachmentArgs": {
|
|
@@ -13941,6 +13989,9 @@
|
|
|
13941
13989
|
{
|
|
13942
13990
|
"$ref": "#/definitions/Model"
|
|
13943
13991
|
},
|
|
13992
|
+
{
|
|
13993
|
+
"$ref": "#/definitions/TargetsResultsSetArgs"
|
|
13994
|
+
},
|
|
13944
13995
|
{
|
|
13945
13996
|
"type": [
|
|
13946
13997
|
"string",
|
|
@@ -2674,23 +2674,23 @@
|
|
|
2674
2674
|
"description": "The editor interaction mode."
|
|
2675
2675
|
},
|
|
2676
2676
|
"finishIfInterrupted": {
|
|
2677
|
-
"description": "
|
|
2677
|
+
"description": "Whether the sketch should commit its geometry if another sketch is activated.",
|
|
2678
2678
|
"type": "boolean"
|
|
2679
2679
|
},
|
|
2680
2680
|
"finishOnDoubleClick": {
|
|
2681
|
-
"description": "
|
|
2681
|
+
"description": "Whether the sketch should stop when double clicking.",
|
|
2682
2682
|
"type": "boolean"
|
|
2683
2683
|
},
|
|
2684
2684
|
"freehand": {
|
|
2685
|
-
"description": "
|
|
2685
|
+
"description": "Whether the sketch is using freehand or segment sketching.",
|
|
2686
2686
|
"type": "boolean"
|
|
2687
2687
|
},
|
|
2688
2688
|
"showBearings": {
|
|
2689
|
-
"description": "
|
|
2689
|
+
"description": "Whether bearing labels should be shown on the map.",
|
|
2690
2690
|
"type": "boolean"
|
|
2691
2691
|
},
|
|
2692
2692
|
"snappingEnabled": {
|
|
2693
|
-
"description": "
|
|
2693
|
+
"description": "Whether snapping should be enabled.",
|
|
2694
2694
|
"type": "boolean"
|
|
2695
2695
|
}
|
|
2696
2696
|
},
|
|
@@ -4979,6 +4979,17 @@
|
|
|
4979
4979
|
},
|
|
4980
4980
|
"type": "object"
|
|
4981
4981
|
},
|
|
4982
|
+
"TargetsResultsSetArgs": {
|
|
4983
|
+
"additionalProperties": false,
|
|
4984
|
+
"description": "Arguments for various commands that target a result set of features.",
|
|
4985
|
+
"properties": {
|
|
4986
|
+
"resultsSetId": {
|
|
4987
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
4988
|
+
"type": "string"
|
|
4989
|
+
}
|
|
4990
|
+
},
|
|
4991
|
+
"type": "object"
|
|
4992
|
+
},
|
|
4982
4993
|
"TimeExtent": {
|
|
4983
4994
|
"additionalProperties": false,
|
|
4984
4995
|
"description": "A time extent for a filter effect.",
|
|
@@ -5377,11 +5388,12 @@
|
|
|
5377
5388
|
"results": {
|
|
5378
5389
|
"$ref": "#/definitions/ModelRef",
|
|
5379
5390
|
"description": "The result component to update, referenced by results model or its ID."
|
|
5391
|
+
},
|
|
5392
|
+
"resultsSetId": {
|
|
5393
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
5394
|
+
"type": "string"
|
|
5380
5395
|
}
|
|
5381
5396
|
},
|
|
5382
|
-
"required": [
|
|
5383
|
-
"results"
|
|
5384
|
-
],
|
|
5385
5397
|
"type": "object"
|
|
5386
5398
|
},
|
|
5387
5399
|
"UpdateSessionArgs": {
|
|
@@ -17349,6 +17361,12 @@
|
|
|
17349
17361
|
"reports.run:input": {
|
|
17350
17362
|
"$ref": "#/definitions/RunReportArgs"
|
|
17351
17363
|
},
|
|
17364
|
+
"results.activate-display-components": {
|
|
17365
|
+
"description": "Activates the current set of results component(s), which is set via results.set-display-components.",
|
|
17366
|
+
"enum": [
|
|
17367
|
+
"results.activate-display-components"
|
|
17368
|
+
]
|
|
17369
|
+
},
|
|
17352
17370
|
"results.add": {
|
|
17353
17371
|
"description": "Adds features to a currently shown set of features.",
|
|
17354
17372
|
"enum": [
|
|
@@ -17369,6 +17387,9 @@
|
|
|
17369
17387
|
{
|
|
17370
17388
|
"$ref": "#/definitions/Model"
|
|
17371
17389
|
},
|
|
17390
|
+
{
|
|
17391
|
+
"$ref": "#/definitions/TargetsResultsSetArgs"
|
|
17392
|
+
},
|
|
17372
17393
|
{
|
|
17373
17394
|
"type": [
|
|
17374
17395
|
"string",
|
|
@@ -17377,6 +17398,27 @@
|
|
|
17377
17398
|
}
|
|
17378
17399
|
]
|
|
17379
17400
|
},
|
|
17401
|
+
"results.contains": {
|
|
17402
|
+
"description": "Check if features are contained in the specified results.",
|
|
17403
|
+
"enum": [
|
|
17404
|
+
"results.contains"
|
|
17405
|
+
]
|
|
17406
|
+
},
|
|
17407
|
+
"results.contains:input": {
|
|
17408
|
+
"additionalProperties": false,
|
|
17409
|
+
"properties": {
|
|
17410
|
+
"resultsSetId": {
|
|
17411
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
17412
|
+
"type": "string"
|
|
17413
|
+
}
|
|
17414
|
+
}
|
|
17415
|
+
},
|
|
17416
|
+
"results.contains:output": {
|
|
17417
|
+
"items": {
|
|
17418
|
+
"type": "boolean"
|
|
17419
|
+
},
|
|
17420
|
+
"type": "array"
|
|
17421
|
+
},
|
|
17380
17422
|
"results.convert-to-csv": {
|
|
17381
17423
|
"description": "Converts the provided Feature(s) to a CSV file grouped by feature source. If there are multiple sources the CSV(s) will be bundled in a zip file.",
|
|
17382
17424
|
"enum": [
|
|
@@ -17830,6 +17872,9 @@
|
|
|
17830
17872
|
{
|
|
17831
17873
|
"$ref": "#/definitions/Model"
|
|
17832
17874
|
},
|
|
17875
|
+
{
|
|
17876
|
+
"$ref": "#/definitions/TargetsResultsSetArgs"
|
|
17877
|
+
},
|
|
17833
17878
|
{
|
|
17834
17879
|
"type": [
|
|
17835
17880
|
"string",
|
|
@@ -21140,6 +21185,9 @@
|
|
|
21140
21185
|
{
|
|
21141
21186
|
"$ref": "#/definitions/reports.run"
|
|
21142
21187
|
},
|
|
21188
|
+
{
|
|
21189
|
+
"$ref": "#/definitions/results.activate-display-components"
|
|
21190
|
+
},
|
|
21143
21191
|
{
|
|
21144
21192
|
"$ref": "#/definitions/results.add"
|
|
21145
21193
|
},
|
|
@@ -21717,6 +21765,22 @@
|
|
|
21717
21765
|
],
|
|
21718
21766
|
"type": "object"
|
|
21719
21767
|
},
|
|
21768
|
+
{
|
|
21769
|
+
"additionalProperties": false,
|
|
21770
|
+
"properties": {
|
|
21771
|
+
"arguments": {
|
|
21772
|
+
"$ref": "#/definitions/results.contains:input"
|
|
21773
|
+
},
|
|
21774
|
+
"name": {
|
|
21775
|
+
"$ref": "#/definitions/results.contains"
|
|
21776
|
+
}
|
|
21777
|
+
},
|
|
21778
|
+
"required": [
|
|
21779
|
+
"name",
|
|
21780
|
+
"arguments"
|
|
21781
|
+
],
|
|
21782
|
+
"type": "object"
|
|
21783
|
+
},
|
|
21720
21784
|
{
|
|
21721
21785
|
"additionalProperties": false,
|
|
21722
21786
|
"properties": {
|
|
@@ -22308,6 +22372,9 @@
|
|
|
22308
22372
|
{
|
|
22309
22373
|
"$ref": "#/definitions/measurement.get-length-units"
|
|
22310
22374
|
},
|
|
22375
|
+
{
|
|
22376
|
+
"$ref": "#/definitions/results.contains"
|
|
22377
|
+
},
|
|
22311
22378
|
{
|
|
22312
22379
|
"$ref": "#/definitions/results.convert-to-csv"
|
|
22313
22380
|
},
|
|
@@ -1081,6 +1081,17 @@
|
|
|
1081
1081
|
],
|
|
1082
1082
|
"type": "object"
|
|
1083
1083
|
},
|
|
1084
|
+
"TargetsResultsSetArgs": {
|
|
1085
|
+
"additionalProperties": false,
|
|
1086
|
+
"description": "Arguments for various commands that target a result set of features.",
|
|
1087
|
+
"properties": {
|
|
1088
|
+
"resultsSetId": {
|
|
1089
|
+
"description": "If specified the results will be updated in the named results set only. Results sets with the prefix 'vgs' are reserved for system use and should not be used unless you are intentionally targeting a well known results set such as the 'vgs-starred' results.",
|
|
1090
|
+
"type": "string"
|
|
1091
|
+
}
|
|
1092
|
+
},
|
|
1093
|
+
"type": "object"
|
|
1094
|
+
},
|
|
1084
1095
|
"TimeSpan": {
|
|
1085
1096
|
"additionalProperties": false,
|
|
1086
1097
|
"type": "object"
|
|
@@ -10050,6 +10061,15 @@
|
|
|
10050
10061
|
"reports.report-started:input": {
|
|
10051
10062
|
"$ref": "#/definitions/ReportStartedEventArgs"
|
|
10052
10063
|
},
|
|
10064
|
+
"results.changed": {
|
|
10065
|
+
"description": "Raised when results are added or removed to a named results set.",
|
|
10066
|
+
"enum": [
|
|
10067
|
+
"results.changed"
|
|
10068
|
+
]
|
|
10069
|
+
},
|
|
10070
|
+
"results.changed:input": {
|
|
10071
|
+
"$ref": "#/definitions/TargetsResultsSetArgs"
|
|
10072
|
+
},
|
|
10053
10073
|
"ui.activated": {
|
|
10054
10074
|
"description": "Raised when a component is activated. The argument is the component ID.",
|
|
10055
10075
|
"enum": [
|
|
@@ -10270,6 +10290,9 @@
|
|
|
10270
10290
|
{
|
|
10271
10291
|
"$ref": "#/definitions/reports.report-started"
|
|
10272
10292
|
},
|
|
10293
|
+
{
|
|
10294
|
+
"$ref": "#/definitions/results.changed"
|
|
10295
|
+
},
|
|
10273
10296
|
{
|
|
10274
10297
|
"$ref": "#/definitions/ui.activated"
|
|
10275
10298
|
},
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED