@vertigis/viewer-spec 56.8.0 → 56.9.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.
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type FieldElement from "@arcgis/core/form/elements/FieldElement.js";
|
|
1
2
|
import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
|
|
2
3
|
import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
|
|
3
4
|
import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
|
|
@@ -85,27 +86,22 @@ export interface AttachmentEventArgs {
|
|
|
85
86
|
attachment: Attachment;
|
|
86
87
|
}
|
|
87
88
|
/**
|
|
88
|
-
*
|
|
89
|
+
* A collection of options common to interactive feature editing sessions. Web
|
|
90
|
+
* only.
|
|
89
91
|
*/
|
|
90
|
-
export interface
|
|
92
|
+
export interface EditOptions {
|
|
91
93
|
/**
|
|
92
|
-
* Whether to show UI notifications.
|
|
94
|
+
* Whether to show UI notifications. Defaults to `true`.
|
|
93
95
|
*/
|
|
94
96
|
showNotifications?: boolean;
|
|
95
97
|
/**
|
|
96
|
-
* The orientation of the template picker.
|
|
98
|
+
* The orientation of the template picker. Defaults to "vertical".
|
|
97
99
|
*/
|
|
98
100
|
orientation?: "horizontal" | "vertical";
|
|
99
101
|
/**
|
|
100
|
-
* Whether to show titles on the template picker.
|
|
102
|
+
* Whether to show titles on the template picker. Defaults to `true`.
|
|
101
103
|
*/
|
|
102
104
|
showTitles?: boolean;
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* A collection of options common to interactive feature editing sessions. Web
|
|
106
|
-
* only.
|
|
107
|
-
*/
|
|
108
|
-
export interface EditOptions {
|
|
109
105
|
/**
|
|
110
106
|
* Whether to allow editing of feature geometry.
|
|
111
107
|
*/
|
|
@@ -151,7 +147,19 @@ export interface UpdateSessionArgs extends HasGeometry {
|
|
|
151
147
|
* subtype group layer, or subtype sublayer is required. The geometry is
|
|
152
148
|
* required for non-tabular features. Web only.
|
|
153
149
|
*/
|
|
154
|
-
export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps
|
|
150
|
+
export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps {
|
|
151
|
+
/**
|
|
152
|
+
* Whether to show UI notifications. Defaults to `true`.
|
|
153
|
+
*/
|
|
154
|
+
showNotifications?: boolean;
|
|
155
|
+
/**
|
|
156
|
+
* The orientation of the template picker. Defaults to "vertical".
|
|
157
|
+
*/
|
|
158
|
+
orientation?: "horizontal" | "vertical";
|
|
159
|
+
/**
|
|
160
|
+
* Whether to show titles on the template picker. Defaults to `true`.
|
|
161
|
+
*/
|
|
162
|
+
showTitles?: boolean;
|
|
155
163
|
/**
|
|
156
164
|
* A collection of attributes to apply to the new feature.
|
|
157
165
|
*/
|
|
@@ -170,7 +178,7 @@ export interface CreateFeatureArgs extends HasGeometry, HasLayers, HasMaps, Edit
|
|
|
170
178
|
/**
|
|
171
179
|
* Arguments for the "edit.display-add-features" command. Web only.
|
|
172
180
|
*/
|
|
173
|
-
export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditOptions
|
|
181
|
+
export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditOptions {
|
|
174
182
|
/**
|
|
175
183
|
* Arguments for the display of the attribute editing form.
|
|
176
184
|
*/
|
|
@@ -179,6 +187,20 @@ export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditO
|
|
|
179
187
|
* Arguments for the display of the template picker.
|
|
180
188
|
*/
|
|
181
189
|
templateUITarget?: HasUITarget;
|
|
190
|
+
/**
|
|
191
|
+
* A collection of configuration overrides for the editable fields.
|
|
192
|
+
*/
|
|
193
|
+
fieldElements?: Partial<FieldElement>[];
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Arguments for the "edit.display-add-related-feature" command. A feature and a
|
|
197
|
+
* relationship ID are supplied as inputs instead of a layer. Web only.
|
|
198
|
+
*/
|
|
199
|
+
export interface DisplayAddRelatedFeatureArgs extends Omit<DisplayAddFeatureArgs, "layers">, HasFeatures {
|
|
200
|
+
/**
|
|
201
|
+
* The ID of the relationship to add a feature to.
|
|
202
|
+
*/
|
|
203
|
+
relationshipId: string;
|
|
182
204
|
}
|
|
183
205
|
/**
|
|
184
206
|
* Arguments for the "edit.display-update-features" operation. Web only.
|
|
@@ -188,6 +210,10 @@ export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry,
|
|
|
188
210
|
* A collection of attributes to automatically apply to the updated feature.
|
|
189
211
|
*/
|
|
190
212
|
featureAttributes?: Record<string, unknown>;
|
|
213
|
+
/**
|
|
214
|
+
* A collection of configuration overrides for the editable fields.
|
|
215
|
+
*/
|
|
216
|
+
fieldElements?: Partial<FieldElement>[];
|
|
191
217
|
}
|
|
192
218
|
/**
|
|
193
219
|
* Arguments for the "edit.add-features", "edit.update-features" and
|
|
@@ -195,7 +221,7 @@ export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry,
|
|
|
195
221
|
*/
|
|
196
222
|
export interface EditCommandArgs extends HasFeatures {
|
|
197
223
|
/**
|
|
198
|
-
* Whether to show UI notifications.
|
|
224
|
+
* Whether to show UI notifications. Will default to `true`.
|
|
199
225
|
*/
|
|
200
226
|
showNotifications?: boolean;
|
|
201
227
|
}
|
|
@@ -1241,6 +1241,13 @@
|
|
|
1241
1241
|
"featureAttributes": {
|
|
1242
1242
|
"description": "A collection of attributes to apply to the new feature."
|
|
1243
1243
|
},
|
|
1244
|
+
"fieldElements": {
|
|
1245
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
1246
|
+
"items": {
|
|
1247
|
+
"$ref": "__type"
|
|
1248
|
+
},
|
|
1249
|
+
"type": "array"
|
|
1250
|
+
},
|
|
1244
1251
|
"formUITarget": {
|
|
1245
1252
|
"$ref": "#/definitions/HasUITarget",
|
|
1246
1253
|
"description": "Arguments for the display of the attribute editing form."
|
|
@@ -1258,7 +1265,7 @@
|
|
|
1258
1265
|
"description": "Map(s) to use for the command/operation."
|
|
1259
1266
|
},
|
|
1260
1267
|
"orientation": {
|
|
1261
|
-
"description": "The orientation of the template picker.",
|
|
1268
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1262
1269
|
"enum": [
|
|
1263
1270
|
"horizontal",
|
|
1264
1271
|
"vertical"
|
|
@@ -1269,11 +1276,11 @@
|
|
|
1269
1276
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
1270
1277
|
},
|
|
1271
1278
|
"showNotifications": {
|
|
1272
|
-
"description": "Whether to show UI notifications.",
|
|
1279
|
+
"description": "Whether to show UI notifications. Defaults to `true`.",
|
|
1273
1280
|
"type": "boolean"
|
|
1274
1281
|
},
|
|
1275
1282
|
"showTitles": {
|
|
1276
|
-
"description": "Whether to show titles on the template picker.",
|
|
1283
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1277
1284
|
"type": "boolean"
|
|
1278
1285
|
},
|
|
1279
1286
|
"templateName": {
|
|
@@ -1363,6 +1370,13 @@
|
|
|
1363
1370
|
"$ref": "#/definitions/FeaturesLike",
|
|
1364
1371
|
"description": "Features to use for the command/operation."
|
|
1365
1372
|
},
|
|
1373
|
+
"fieldElements": {
|
|
1374
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
1375
|
+
"items": {
|
|
1376
|
+
"$ref": "__type"
|
|
1377
|
+
},
|
|
1378
|
+
"type": "array"
|
|
1379
|
+
},
|
|
1366
1380
|
"geometry": {
|
|
1367
1381
|
"$ref": "#/definitions/GeometryLike",
|
|
1368
1382
|
"description": "The geometry to use for the command/operation."
|
|
@@ -1375,6 +1389,14 @@
|
|
|
1375
1389
|
"$ref": "MapsLike",
|
|
1376
1390
|
"description": "Map(s) to use for the command/operation."
|
|
1377
1391
|
},
|
|
1392
|
+
"orientation": {
|
|
1393
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1394
|
+
"enum": [
|
|
1395
|
+
"horizontal",
|
|
1396
|
+
"vertical"
|
|
1397
|
+
],
|
|
1398
|
+
"type": "string"
|
|
1399
|
+
},
|
|
1378
1400
|
"parent": {
|
|
1379
1401
|
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.",
|
|
1380
1402
|
"type": "string"
|
|
@@ -1383,7 +1405,11 @@
|
|
|
1383
1405
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
1384
1406
|
},
|
|
1385
1407
|
"showNotifications": {
|
|
1386
|
-
"description": "Whether to show UI notifications.",
|
|
1408
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
1409
|
+
"type": "boolean"
|
|
1410
|
+
},
|
|
1411
|
+
"showTitles": {
|
|
1412
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1387
1413
|
"type": "boolean"
|
|
1388
1414
|
}
|
|
1389
1415
|
},
|
|
@@ -1398,7 +1424,7 @@
|
|
|
1398
1424
|
"description": "Features to use for the command/operation."
|
|
1399
1425
|
},
|
|
1400
1426
|
"showNotifications": {
|
|
1401
|
-
"description": "Whether to show UI notifications.",
|
|
1427
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
1402
1428
|
"type": "boolean"
|
|
1403
1429
|
}
|
|
1404
1430
|
},
|
|
@@ -1445,6 +1445,13 @@
|
|
|
1445
1445
|
"featureAttributes": {
|
|
1446
1446
|
"description": "A collection of attributes to apply to the new feature."
|
|
1447
1447
|
},
|
|
1448
|
+
"fieldElements": {
|
|
1449
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
1450
|
+
"items": {
|
|
1451
|
+
"$ref": "__type"
|
|
1452
|
+
},
|
|
1453
|
+
"type": "array"
|
|
1454
|
+
},
|
|
1448
1455
|
"formUITarget": {
|
|
1449
1456
|
"$ref": "#/definitions/HasUITarget",
|
|
1450
1457
|
"description": "Arguments for the display of the attribute editing form."
|
|
@@ -1462,7 +1469,7 @@
|
|
|
1462
1469
|
"description": "Map(s) to use for the command/operation."
|
|
1463
1470
|
},
|
|
1464
1471
|
"orientation": {
|
|
1465
|
-
"description": "The orientation of the template picker.",
|
|
1472
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1466
1473
|
"enum": [
|
|
1467
1474
|
"horizontal",
|
|
1468
1475
|
"vertical"
|
|
@@ -1473,11 +1480,11 @@
|
|
|
1473
1480
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
1474
1481
|
},
|
|
1475
1482
|
"showNotifications": {
|
|
1476
|
-
"description": "Whether to show UI notifications.",
|
|
1483
|
+
"description": "Whether to show UI notifications. Defaults to `true`.",
|
|
1477
1484
|
"type": "boolean"
|
|
1478
1485
|
},
|
|
1479
1486
|
"showTitles": {
|
|
1480
|
-
"description": "Whether to show titles on the template picker.",
|
|
1487
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1481
1488
|
"type": "boolean"
|
|
1482
1489
|
},
|
|
1483
1490
|
"templateName": {
|
|
@@ -1637,6 +1644,13 @@
|
|
|
1637
1644
|
"$ref": "#/definitions/FeaturesLike",
|
|
1638
1645
|
"description": "Features to use for the command/operation."
|
|
1639
1646
|
},
|
|
1647
|
+
"fieldElements": {
|
|
1648
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
1649
|
+
"items": {
|
|
1650
|
+
"$ref": "__type"
|
|
1651
|
+
},
|
|
1652
|
+
"type": "array"
|
|
1653
|
+
},
|
|
1640
1654
|
"geometry": {
|
|
1641
1655
|
"$ref": "#/definitions/GeometryLike",
|
|
1642
1656
|
"description": "The geometry to use for the command/operation."
|
|
@@ -1649,6 +1663,14 @@
|
|
|
1649
1663
|
"$ref": "MapsLike",
|
|
1650
1664
|
"description": "Map(s) to use for the command/operation."
|
|
1651
1665
|
},
|
|
1666
|
+
"orientation": {
|
|
1667
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1668
|
+
"enum": [
|
|
1669
|
+
"horizontal",
|
|
1670
|
+
"vertical"
|
|
1671
|
+
],
|
|
1672
|
+
"type": "string"
|
|
1673
|
+
},
|
|
1652
1674
|
"parent": {
|
|
1653
1675
|
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.",
|
|
1654
1676
|
"type": "string"
|
|
@@ -1657,7 +1679,11 @@
|
|
|
1657
1679
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
1658
1680
|
},
|
|
1659
1681
|
"showNotifications": {
|
|
1660
|
-
"description": "Whether to show UI notifications.",
|
|
1682
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
1683
|
+
"type": "boolean"
|
|
1684
|
+
},
|
|
1685
|
+
"showTitles": {
|
|
1686
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1661
1687
|
"type": "boolean"
|
|
1662
1688
|
}
|
|
1663
1689
|
},
|
|
@@ -1672,7 +1698,7 @@
|
|
|
1672
1698
|
"description": "Features to use for the command/operation."
|
|
1673
1699
|
},
|
|
1674
1700
|
"showNotifications": {
|
|
1675
|
-
"description": "Whether to show UI notifications.",
|
|
1701
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
1676
1702
|
"type": "boolean"
|
|
1677
1703
|
}
|
|
1678
1704
|
},
|
|
@@ -1559,7 +1559,7 @@
|
|
|
1559
1559
|
"description": "Map(s) to use for the command/operation."
|
|
1560
1560
|
},
|
|
1561
1561
|
"orientation": {
|
|
1562
|
-
"description": "The orientation of the template picker.",
|
|
1562
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1563
1563
|
"enum": [
|
|
1564
1564
|
"horizontal",
|
|
1565
1565
|
"vertical"
|
|
@@ -1567,11 +1567,11 @@
|
|
|
1567
1567
|
"type": "string"
|
|
1568
1568
|
},
|
|
1569
1569
|
"showNotifications": {
|
|
1570
|
-
"description": "Whether to show UI notifications.",
|
|
1570
|
+
"description": "Whether to show UI notifications. Defaults to `true`.",
|
|
1571
1571
|
"type": "boolean"
|
|
1572
1572
|
},
|
|
1573
1573
|
"showTitles": {
|
|
1574
|
-
"description": "Whether to show titles on the template picker.",
|
|
1574
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1575
1575
|
"type": "boolean"
|
|
1576
1576
|
},
|
|
1577
1577
|
"templateName": {
|
|
@@ -1938,6 +1938,13 @@
|
|
|
1938
1938
|
"featureAttributes": {
|
|
1939
1939
|
"description": "A collection of attributes to apply to the new feature."
|
|
1940
1940
|
},
|
|
1941
|
+
"fieldElements": {
|
|
1942
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
1943
|
+
"items": {
|
|
1944
|
+
"$ref": "__type"
|
|
1945
|
+
},
|
|
1946
|
+
"type": "array"
|
|
1947
|
+
},
|
|
1941
1948
|
"formUITarget": {
|
|
1942
1949
|
"$ref": "#/definitions/HasUITarget",
|
|
1943
1950
|
"description": "Arguments for the display of the attribute editing form."
|
|
@@ -1955,7 +1962,7 @@
|
|
|
1955
1962
|
"description": "Map(s) to use for the command/operation."
|
|
1956
1963
|
},
|
|
1957
1964
|
"orientation": {
|
|
1958
|
-
"description": "The orientation of the template picker.",
|
|
1965
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
1959
1966
|
"enum": [
|
|
1960
1967
|
"horizontal",
|
|
1961
1968
|
"vertical"
|
|
@@ -1966,11 +1973,11 @@
|
|
|
1966
1973
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
1967
1974
|
},
|
|
1968
1975
|
"showNotifications": {
|
|
1969
|
-
"description": "Whether to show UI notifications.",
|
|
1976
|
+
"description": "Whether to show UI notifications. Defaults to `true`.",
|
|
1970
1977
|
"type": "boolean"
|
|
1971
1978
|
},
|
|
1972
1979
|
"showTitles": {
|
|
1973
|
-
"description": "Whether to show titles on the template picker.",
|
|
1980
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
1974
1981
|
"type": "boolean"
|
|
1975
1982
|
},
|
|
1976
1983
|
"templateName": {
|
|
@@ -2060,6 +2067,13 @@
|
|
|
2060
2067
|
"$ref": "#/definitions/FeaturesLike",
|
|
2061
2068
|
"description": "Features to use for the command/operation."
|
|
2062
2069
|
},
|
|
2070
|
+
"fieldElements": {
|
|
2071
|
+
"description": "A collection of configuration overrides for the editable fields.",
|
|
2072
|
+
"items": {
|
|
2073
|
+
"$ref": "__type"
|
|
2074
|
+
},
|
|
2075
|
+
"type": "array"
|
|
2076
|
+
},
|
|
2063
2077
|
"geometry": {
|
|
2064
2078
|
"$ref": "#/definitions/GeometryLike",
|
|
2065
2079
|
"description": "The geometry to use for the command/operation."
|
|
@@ -2072,6 +2086,14 @@
|
|
|
2072
2086
|
"$ref": "MapsLike",
|
|
2073
2087
|
"description": "Map(s) to use for the command/operation."
|
|
2074
2088
|
},
|
|
2089
|
+
"orientation": {
|
|
2090
|
+
"description": "The orientation of the template picker. Defaults to \"vertical\".",
|
|
2091
|
+
"enum": [
|
|
2092
|
+
"horizontal",
|
|
2093
|
+
"vertical"
|
|
2094
|
+
],
|
|
2095
|
+
"type": "string"
|
|
2096
|
+
},
|
|
2075
2097
|
"parent": {
|
|
2076
2098
|
"description": "The layout ID or ItemRef to target for the command/operation. This component will be the parent of the temporary UI that will be removed after the command/operation completes.",
|
|
2077
2099
|
"type": "string"
|
|
@@ -2080,7 +2102,11 @@
|
|
|
2080
2102
|
"description": "Web only. Additional settings that are specific to sketching plugins, keyed by plugin ID. The only currently supported plugin is \"snapping\". A boolean value can also be assigned to completely disable, or enable with default settings."
|
|
2081
2103
|
},
|
|
2082
2104
|
"showNotifications": {
|
|
2083
|
-
"description": "Whether to show UI notifications.",
|
|
2105
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
2106
|
+
"type": "boolean"
|
|
2107
|
+
},
|
|
2108
|
+
"showTitles": {
|
|
2109
|
+
"description": "Whether to show titles on the template picker. Defaults to `true`.",
|
|
2084
2110
|
"type": "boolean"
|
|
2085
2111
|
}
|
|
2086
2112
|
},
|
|
@@ -2183,7 +2209,7 @@
|
|
|
2183
2209
|
"description": "Features to use for the command/operation."
|
|
2184
2210
|
},
|
|
2185
2211
|
"showNotifications": {
|
|
2186
|
-
"description": "Whether to show UI notifications.",
|
|
2212
|
+
"description": "Whether to show UI notifications. Will default to `true`.",
|
|
2187
2213
|
"type": "boolean"
|
|
2188
2214
|
}
|
|
2189
2215
|
},
|
package/package.json
CHANGED
package/version.d.ts
CHANGED
package/version.js
CHANGED