@vertigis/viewer-spec 56.24.0 → 56.26.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (268) hide show
  1. package/analytics/AnalyticsContext.d.ts +29 -29
  2. package/analytics/AnalyticsContext.js +1 -1
  3. package/analytics/CommonAction.d.ts +90 -90
  4. package/analytics/CommonAction.js +1 -1
  5. package/analytics/MobileAction.d.ts +113 -113
  6. package/analytics/MobileAction.js +1 -1
  7. package/analytics/WebAction.d.ts +102 -102
  8. package/analytics/WebAction.js +1 -1
  9. package/app-config/AppConfig.d.ts +55 -55
  10. package/app-config/ItemConfig.d.ts +18 -18
  11. package/app-config/common/AnalyticsModelProperties.d.ts +10 -10
  12. package/app-config/common/ApplicationModelProperties.d.ts +15 -15
  13. package/app-config/common/BasemapPickerModelProperties.d.ts +6 -6
  14. package/app-config/common/BookmarksModelProperties.d.ts +17 -17
  15. package/app-config/common/BrandingColors.d.ts +102 -102
  16. package/app-config/common/BrandingModelProperties.d.ts +23 -23
  17. package/app-config/common/BrandingThemeProperties.d.ts +35 -35
  18. package/app-config/common/CompassModelProperties.d.ts +6 -6
  19. package/app-config/common/ComponentModelProperties.d.ts +14 -14
  20. package/app-config/common/CoordinateFormat.d.ts +4 -4
  21. package/app-config/common/CoordinateModelProperties.d.ts +43 -43
  22. package/app-config/common/DialogModelProperties.d.ts +6 -6
  23. package/app-config/common/EventListenerModelProperties.d.ts +44 -44
  24. package/app-config/common/ExpandModelProperties.d.ts +6 -6
  25. package/app-config/common/FeatureDetailsModelProperties.d.ts +27 -27
  26. package/app-config/common/GeolocationModelProperties.d.ts +6 -6
  27. package/app-config/common/HighlightModelProperties.d.ts +68 -68
  28. package/app-config/common/ImageModelProperties.d.ts +14 -14
  29. package/app-config/common/ItemRef.d.ts +4 -4
  30. package/app-config/common/LayerListModelProperties.d.ts +6 -6
  31. package/app-config/common/LayerPresetsModelProperties.d.ts +14 -14
  32. package/app-config/common/LayoutProperties.d.ts +33 -33
  33. package/app-config/common/LegendModelProperties.d.ts +6 -6
  34. package/app-config/common/LicensingModelProperties.d.ts +10 -10
  35. package/app-config/common/MapCoordinatesModelProperties.d.ts +6 -6
  36. package/app-config/common/MapModelProperties.d.ts +7 -7
  37. package/app-config/common/MenuModelProperties.d.ts +13 -13
  38. package/app-config/common/ModelProperties.d.ts +6 -6
  39. package/app-config/common/PanelModelProperties.d.ts +6 -6
  40. package/app-config/common/RegionModelProperties.d.ts +25 -25
  41. package/app-config/common/ResultsModelProperties.d.ts +13 -13
  42. package/app-config/common/ScalebarModelProperties.d.ts +6 -6
  43. package/app-config/common/SearchModelProperties.d.ts +26 -26
  44. package/app-config/common/ServiceModelProperties.d.ts +6 -6
  45. package/app-config/common/SplitModelProperties.d.ts +6 -6
  46. package/app-config/common/StackModelProperties.d.ts +6 -6
  47. package/app-config/common/TextModelProperties.d.ts +10 -10
  48. package/app-config/common/TranslatableText.d.ts +35 -35
  49. package/app-config/common/UserModelProperties.d.ts +6 -6
  50. package/app-config/common/WorkflowEventsProperties.d.ts +11 -11
  51. package/app-config/common/WorkflowModelProperties.d.ts +44 -44
  52. package/app-config/common/ZoomModelProperties.d.ts +6 -6
  53. package/app-config/common/colors.d.ts +6 -6
  54. package/app-config/index.d.ts +2 -2
  55. package/app-config/mobile/AddFeatureModelProperties.d.ts +6 -6
  56. package/app-config/mobile/AddRelatedFeatureModelProperties.d.ts +6 -6
  57. package/app-config/mobile/BasemapModelProperties.d.ts +11 -11
  58. package/app-config/mobile/CoordinateModelProperties.d.ts +10 -10
  59. package/app-config/mobile/FeatureDetailsModelProperties.d.ts +26 -26
  60. package/app-config/mobile/GeometryToolbarModelProperties.d.ts +6 -6
  61. package/app-config/mobile/GnssDeviceSelectionModelProperties.d.ts +6 -6
  62. package/app-config/mobile/GnssDeviceSettingsModelProperties.d.ts +6 -6
  63. package/app-config/mobile/GnssMetadataModelProperties.d.ts +6 -6
  64. package/app-config/mobile/MapModelProperties.d.ts +52 -52
  65. package/app-config/mobile/OfflineModelProperties.d.ts +48 -48
  66. package/app-config/mobile/PortalExtensionSettingsProperties.d.ts +27 -27
  67. package/app-config/mobile/ScrollModelProperties.d.ts +6 -6
  68. package/app-config/mobile/SearchModelProperties.d.ts +14 -14
  69. package/app-config/mobile/SelectLayerSettingsModelProperties.d.ts +11 -11
  70. package/app-config/mobile/TaskbarModelProperties.d.ts +6 -6
  71. package/app-config/mobile/UpdateFeatureModelProperties.d.ts +6 -6
  72. package/app-config/mobile/VertigisMobileModelProperties.d.ts +67 -67
  73. package/app-config/schema/common-app-config.schema.json +1 -1
  74. package/app-config/schema/web-app-config.schema.json +1 -1
  75. package/app-config/web/AddressModelProperties.d.ts +6 -6
  76. package/app-config/web/BasemapModelProperties.d.ts +10 -10
  77. package/app-config/web/BasemapPickerModelProperties.d.ts +7 -7
  78. package/app-config/web/BookmarksModelProperties.d.ts +7 -7
  79. package/app-config/web/BrandingModelProperties.d.ts +14 -14
  80. package/app-config/web/ChartModelProperties.d.ts +58 -58
  81. package/app-config/web/CompassModelProperties.d.ts +7 -7
  82. package/app-config/web/ComponentModelProperties.d.ts +12 -12
  83. package/app-config/web/CoordinateModelProperties.d.ts +50 -50
  84. package/app-config/web/DataLinkSourceProperties.d.ts +15 -15
  85. package/app-config/web/DialogModelProperties.d.ts +7 -7
  86. package/app-config/web/DrawModelProperties.d.ts +94 -94
  87. package/app-config/web/FeatureDetailsModelProperties.d.ts +19 -19
  88. package/app-config/web/FeatureInfoModelProperties.d.ts +38 -38
  89. package/app-config/web/FeatureListProperties.d.ts +12 -12
  90. package/app-config/web/FeatureSetProperties.d.ts +16 -16
  91. package/app-config/web/FeatureSummaryModelProperties.d.ts +27 -27
  92. package/app-config/web/GeolocationModelProperties.d.ts +7 -7
  93. package/app-config/web/GeometryModelProperties.d.ts +27 -27
  94. package/app-config/web/HasVisibilityFilters.d.ts +36 -36
  95. package/app-config/web/ImageModelProperties.d.ts +7 -7
  96. package/app-config/web/KpiCardModelProperties.d.ts +146 -146
  97. package/app-config/web/LayerListModelProperties.d.ts +18 -18
  98. package/app-config/web/LayerPresetsModelProperties.d.ts +7 -7
  99. package/app-config/web/LegendModelProperties.d.ts +7 -7
  100. package/app-config/web/Map3dToggleModelProperties.d.ts +6 -6
  101. package/app-config/web/MapCoordinatesModelProperties.d.ts +50 -50
  102. package/app-config/web/MapModelProperties.d.ts +93 -87
  103. package/app-config/web/MeasurementModelProperties.d.ts +36 -36
  104. package/app-config/web/MenuItemModelProperties.d.ts +7 -7
  105. package/app-config/web/MenuModelProperties.d.ts +13 -13
  106. package/app-config/web/ModelProperties.d.ts +7 -7
  107. package/app-config/web/PanelModelProperties.d.ts +7 -7
  108. package/app-config/web/PortalModelProperties.d.ts +11 -11
  109. package/app-config/web/PrintFormModelProperties.d.ts +42 -42
  110. package/app-config/web/PrintModelProperties.d.ts +11 -11
  111. package/app-config/web/ProjectModelProperties.d.ts +12 -12
  112. package/app-config/web/QueryBuilderModelProperties.d.ts +22 -22
  113. package/app-config/web/ReportModelProperties.d.ts +15 -15
  114. package/app-config/web/ResultsModelProperties.d.ts +101 -101
  115. package/app-config/web/ResultsServiceModelProperties.d.ts +48 -48
  116. package/app-config/web/ScaleInputModelProperties.d.ts +6 -6
  117. package/app-config/web/ScalebarModelProperties.d.ts +22 -22
  118. package/app-config/web/SearchModelProperties.d.ts +22 -22
  119. package/app-config/web/SearchServiceProperties.d.ts +25 -25
  120. package/app-config/web/SharedProjectsModelProperties.d.ts +53 -53
  121. package/app-config/web/SharedStorageModelProperties.d.ts +30 -30
  122. package/app-config/web/SnappingProperties.d.ts +101 -101
  123. package/app-config/web/SplitModelProperties.d.ts +7 -7
  124. package/app-config/web/StackModelProperties.d.ts +7 -7
  125. package/app-config/web/TabsModelProperties.d.ts +6 -6
  126. package/app-config/web/TextModelProperties.d.ts +7 -7
  127. package/app-config/web/TopologyProperties.d.ts +67 -0
  128. package/app-config/web/TopologyProperties.js +1 -0
  129. package/app-config/web/UserModelProperties.d.ts +12 -12
  130. package/app-config/web/UserPreferencesModelProperties.d.ts +10 -10
  131. package/app-config/web/VertigisWebModelProperties.d.ts +74 -74
  132. package/app-config/web/WorkflowModelProperties.d.ts +13 -13
  133. package/app-config/web/ZoomModelProperties.d.ts +7 -7
  134. package/messaging/Command.d.ts +76 -76
  135. package/messaging/CommandRegistry.d.ts +25 -25
  136. package/messaging/CommandRegistry.js +1 -1
  137. package/messaging/DotNetTypes.d.ts +4 -4
  138. package/messaging/Event.d.ts +26 -26
  139. package/messaging/EventRegistry.d.ts +25 -25
  140. package/messaging/EventRegistry.js +1 -1
  141. package/messaging/Message.d.ts +50 -50
  142. package/messaging/MessageBus.d.ts +54 -54
  143. package/messaging/Operation.d.ts +77 -77
  144. package/messaging/OperationRegistry.d.ts +26 -26
  145. package/messaging/OperationRegistry.js +1 -1
  146. package/messaging/common.d.ts +354 -354
  147. package/messaging/mobile.d.ts +6 -6
  148. package/messaging/registry/Commands.d.ts +78 -78
  149. package/messaging/registry/Commands.js +1 -1
  150. package/messaging/registry/Events.d.ts +62 -62
  151. package/messaging/registry/Events.js +1 -1
  152. package/messaging/registry/Operations.d.ts +69 -69
  153. package/messaging/registry/Operations.js +1 -1
  154. package/messaging/registry/app-config.d.ts +12 -12
  155. package/messaging/registry/app-config.js +1 -1
  156. package/messaging/registry/app.d.ts +264 -264
  157. package/messaging/registry/app.js +1 -1
  158. package/messaging/registry/arcade.d.ts +115 -115
  159. package/messaging/registry/arcade.js +1 -1
  160. package/messaging/registry/auth.d.ts +151 -151
  161. package/messaging/registry/auth.js +1 -1
  162. package/messaging/registry/basemap.d.ts +74 -74
  163. package/messaging/registry/basemap.js +1 -1
  164. package/messaging/registry/bookmark.d.ts +42 -42
  165. package/messaging/registry/bookmark.js +1 -1
  166. package/messaging/registry/charts.d.ts +81 -81
  167. package/messaging/registry/charts.js +1 -1
  168. package/messaging/registry/debugConsole.d.ts +26 -26
  169. package/messaging/registry/debugConsole.js +1 -1
  170. package/messaging/registry/device.d.ts +28 -28
  171. package/messaging/registry/device.js +1 -1
  172. package/messaging/registry/display.d.ts +17 -17
  173. package/messaging/registry/display.js +1 -1
  174. package/messaging/registry/drawing.d.ts +149 -149
  175. package/messaging/registry/drawing.js +1 -1
  176. package/messaging/registry/edit.d.ts +371 -371
  177. package/messaging/registry/edit.js +1 -1
  178. package/messaging/registry/file.d.ts +156 -156
  179. package/messaging/registry/file.js +1 -1
  180. package/messaging/registry/filter-builder.d.ts +73 -73
  181. package/messaging/registry/filter-builder.js +1 -1
  182. package/messaging/registry/geocode.d.ts +87 -87
  183. package/messaging/registry/geocode.js +1 -1
  184. package/messaging/registry/geolocation.d.ts +499 -499
  185. package/messaging/registry/geolocation.js +1 -1
  186. package/messaging/registry/geometry-toolbar.d.ts +29 -29
  187. package/messaging/registry/geometry-toolbar.js +1 -1
  188. package/messaging/registry/geometry.d.ts +278 -278
  189. package/messaging/registry/geometry.js +1 -1
  190. package/messaging/registry/highlights.d.ts +86 -86
  191. package/messaging/registry/highlights.js +1 -1
  192. package/messaging/registry/input.d.ts +22 -22
  193. package/messaging/registry/input.js +1 -1
  194. package/messaging/registry/iwtm.d.ts +11 -11
  195. package/messaging/registry/iwtm.js +1 -1
  196. package/messaging/registry/kpi.d.ts +98 -98
  197. package/messaging/registry/kpi.js +1 -1
  198. package/messaging/registry/layer-comparison.d.ts +104 -104
  199. package/messaging/registry/layer-comparison.js +1 -1
  200. package/messaging/registry/layer-presets.d.ts +49 -49
  201. package/messaging/registry/layer-presets.js +1 -1
  202. package/messaging/registry/layers.d.ts +196 -196
  203. package/messaging/registry/layers.js +1 -1
  204. package/messaging/registry/layout.d.ts +49 -49
  205. package/messaging/registry/layout.js +1 -1
  206. package/messaging/registry/licensing.d.ts +38 -38
  207. package/messaging/registry/licensing.js +1 -1
  208. package/messaging/registry/location-marker.d.ts +171 -171
  209. package/messaging/registry/location-marker.js +1 -1
  210. package/messaging/registry/logViewer.d.ts +17 -17
  211. package/messaging/registry/logViewer.js +1 -1
  212. package/messaging/registry/map.d.ts +1275 -1275
  213. package/messaging/registry/map.js +1 -1
  214. package/messaging/registry/measurement.d.ts +168 -168
  215. package/messaging/registry/measurement.js +1 -1
  216. package/messaging/registry/messaging.d.ts +23 -23
  217. package/messaging/registry/messaging.js +1 -1
  218. package/messaging/registry/network.d.ts +46 -46
  219. package/messaging/registry/network.js +1 -1
  220. package/messaging/registry/offline.d.ts +508 -507
  221. package/messaging/registry/offline.js +1 -1
  222. package/messaging/registry/panel.d.ts +115 -115
  223. package/messaging/registry/panel.js +1 -1
  224. package/messaging/registry/photos.d.ts +47 -47
  225. package/messaging/registry/photos.js +1 -1
  226. package/messaging/registry/portal.d.ts +94 -94
  227. package/messaging/registry/portal.js +1 -1
  228. package/messaging/registry/printing.d.ts +166 -166
  229. package/messaging/registry/printing.js +1 -1
  230. package/messaging/registry/project.d.ts +144 -144
  231. package/messaging/registry/project.js +1 -1
  232. package/messaging/registry/query-builder.d.ts +83 -83
  233. package/messaging/registry/query-builder.js +1 -1
  234. package/messaging/registry/region.d.ts +23 -23
  235. package/messaging/registry/region.js +1 -1
  236. package/messaging/registry/reports.d.ts +135 -135
  237. package/messaging/registry/reports.js +1 -1
  238. package/messaging/registry/results.d.ts +671 -671
  239. package/messaging/registry/results.js +1 -1
  240. package/messaging/registry/search.d.ts +74 -74
  241. package/messaging/registry/search.js +1 -1
  242. package/messaging/registry/settings.d.ts +38 -38
  243. package/messaging/registry/settings.js +1 -1
  244. package/messaging/registry/shortcut.d.ts +41 -41
  245. package/messaging/registry/shortcut.js +1 -1
  246. package/messaging/registry/sketching.d.ts +1019 -960
  247. package/messaging/registry/sketching.js +1 -1
  248. package/messaging/registry/studioAnalytics.d.ts +25 -25
  249. package/messaging/registry/studioAnalytics.js +1 -1
  250. package/messaging/registry/system.d.ts +277 -277
  251. package/messaging/registry/system.js +1 -1
  252. package/messaging/registry/tasks.d.ts +323 -323
  253. package/messaging/registry/tasks.js +1 -1
  254. package/messaging/registry/ui.d.ts +518 -518
  255. package/messaging/registry/ui.js +1 -1
  256. package/messaging/registry/viewer.d.ts +145 -145
  257. package/messaging/registry/viewer.js +1 -1
  258. package/messaging/registry/workflow.d.ts +170 -170
  259. package/messaging/registry/workflow.js +1 -1
  260. package/messaging/schema/common-action.schema.json +6437 -12158
  261. package/messaging/schema/common-event.schema.json +107 -803
  262. package/messaging/schema/mobile-action.schema.json +7719 -16138
  263. package/messaging/schema/mobile-event.schema.json +181 -2422
  264. package/messaging/schema/web-action.schema.json +8415 -23272
  265. package/messaging/schema/web-event.schema.json +183 -1937
  266. package/package.json +20 -20
  267. package/version.d.ts +4 -4
  268. package/version.js +4 -4
@@ -1,371 +1,371 @@
1
- import type FieldElement from "@arcgis/core/form/elements/FieldElement.js";
2
- import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
3
- import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
4
- import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
5
- import type { Command } from "../Command.js";
6
- import { CommandRegistry } from "../CommandRegistry.js";
7
- import type { Event } from "../Event.js";
8
- import { EventRegistry } from "../EventRegistry.js";
9
- import type { Operation } from "../Operation.js";
10
- import { OperationRegistry } from "../OperationRegistry.js";
11
- import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
12
- import type { EditGeometryOptions } from "./sketching.js";
13
- /**
14
- * Arguments for the "edit.add-attachment" command. Supported by both Web and
15
- * Mobile.
16
- */
17
- export interface AddAttachmentArgs {
18
- /**
19
- * The map.
20
- */
21
- maps: MapsLike;
22
- /**
23
- * The feature(s) to add the attachment to.
24
- */
25
- features: Feature[];
26
- /**
27
- * The name of the attachment.
28
- */
29
- name: string;
30
- /**
31
- * The MIME content type of the attachment.
32
- */
33
- contentType: string;
34
- /**
35
- * The binary data for the attachment.
36
- */
37
- data: number[];
38
- }
39
- /**
40
- * VertiGIS Studio Web's arguments for the "edit.add-attachment" command. Not
41
- * supported by Mobile.
42
- */
43
- export interface WebAddAttachmentArgs {
44
- /**
45
- * The feature(s) to add the attachment(s) to. If multiple features are
46
- * specified, the attachment(s) will be added to all features.
47
- */
48
- features: Features;
49
- /**
50
- * The blob(s) that contains the file attachment(s). If multiple attachments
51
- * are specified, all attachment will be added to the feature(s).
52
- */
53
- blobs: File | File[];
54
- }
55
- /**
56
- * Arguments for the "edit.delete-attachment" command.
57
- */
58
- export interface DeleteAttachmentArgs {
59
- /**
60
- * The feature(s) to remove the attachment(s) from.
61
- */
62
- features: Features;
63
- /**
64
- * The attachment(s) to remove from the feature(s). This property can be
65
- * populated with the title(s) or ID(s) of the attachments(s). Any and all
66
- * matching attachments found on the input features will be deleted. Web
67
- * only.
68
- */
69
- attachments?: string[];
70
- /**
71
- * The attachment to remove from the feature(s). Mobile only.
72
- */
73
- gcxAttachment?: Attachment;
74
- }
75
- /**
76
- * Arguments for various attachment events.
77
- */
78
- export interface AttachmentEventArgs {
79
- /**
80
- * The feature that had an attachment added/updated/deleted.
81
- */
82
- feature: Feature;
83
- /**
84
- * The attachment that was added/updated/deleted.
85
- */
86
- attachment: Attachment;
87
- }
88
- /**
89
- * A collection of options common to interactive feature editing sessions. Web
90
- * only.
91
- */
92
- export interface EditOptions {
93
- /**
94
- * Whether to show UI notifications. Defaults to `true`.
95
- */
96
- showNotifications?: boolean;
97
- /**
98
- * The orientation of the template picker. Defaults to "vertical".
99
- */
100
- orientation?: "horizontal" | "vertical";
101
- /**
102
- * Whether to show titles on the template picker. Defaults to `true`.
103
- */
104
- showTitles?: boolean;
105
- /**
106
- * Whether to allow editing of feature geometry.
107
- */
108
- editGeometry?: boolean;
109
- /**
110
- * Whether to allow editing of feature attributes.
111
- */
112
- editAttributes?: boolean;
113
- /**
114
- * Whether to allow editing of feature attachments.
115
- */
116
- editAttachments?: boolean;
117
- /**
118
- * Options for the geometry editing session.
119
- */
120
- editGeometryOptions?: EditGeometryOptions;
121
- /**
122
- * Web only. Additional settings that are specific to sketching plugins,
123
- * keyed by plugin ID. The only currently supported plugin is "snapping". A
124
- * boolean value can also be assigned to completely disable, or enable with
125
- * default settings.
126
- */
127
- pluginSettings?: Record<string, boolean | Record<string, unknown>>;
128
- }
129
- /**
130
- * Used to update an in-progress interactive feature editing session with new
131
- * attributes, attachments or geometry. Web only.
132
- */
133
- export interface UpdateSessionArgs extends HasGeometry {
134
- /**
135
- * A collection of attributes that apply or are to be applied to the
136
- * currently edited feature.
137
- */
138
- attributes?: Record<string, string | number>;
139
- /**
140
- * A collection of attachments that apply or are to be applied to the
141
- * currently edited feature.
142
- */
143
- attachments?: Attachment[];
144
- }
145
- /**
146
- * Arguments for the "edit.create-feature" operation. A valid feature layer,
147
- * subtype group layer, or subtype sublayer is required. The geometry is
148
- * required for non-tabular features. Web only.
149
- */
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;
163
- /**
164
- * A collection of attributes to apply to the new feature.
165
- */
166
- featureAttributes?: Record<string, unknown>;
167
- /**
168
- * The template to use as a starting point for this feature. Requires a
169
- * layer. The default or first template will be used if not set.
170
- */
171
- templateName?: string;
172
- /**
173
- * A type id to use as a starting point for this feature. This may return
174
- * one or more templates and requires a layer with types defined.
175
- */
176
- typeId?: string;
177
- }
178
- /**
179
- * Arguments for the "edit.display-add-feature" command. Web only.
180
- */
181
- export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditOptions {
182
- /**
183
- * Arguments for the display of the attribute editing form. Web only.
184
- */
185
- formUITarget?: HasUITarget;
186
- /**
187
- * Arguments for the display of the template picker. Web only.
188
- */
189
- templateUITarget?: HasUITarget;
190
- /**
191
- * A collection of configuration overrides for the editable fields. Web
192
- * only.
193
- */
194
- fieldElements?: Partial<FieldElement>[];
195
- }
196
- /**
197
- * Arguments for the "edit.display-add-related-feature" command. A feature and a
198
- * relationship ID are supplied as inputs instead of a layer.
199
- */
200
- export interface DisplayAddRelatedFeatureArgs extends Omit<DisplayAddFeatureArgs, "layers">, HasFeatures {
201
- /**
202
- * The ID of the relationship to add a feature to.
203
- */
204
- relationshipId: string;
205
- /**
206
- * The feature source for the related feature to create. Mobile only.
207
- */
208
- relatedFeatureSource: FeatureSource;
209
- }
210
- /**
211
- * Arguments for the "edit.display-update-features" operation. Web only.
212
- */
213
- export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry, HasMaps, HasUITarget, EditOptions {
214
- /**
215
- * A collection of attributes to automatically apply to the updated feature.
216
- */
217
- featureAttributes?: Record<string, unknown>;
218
- /**
219
- * A collection of configuration overrides for the editable fields.
220
- */
221
- fieldElements?: Partial<FieldElement>[];
222
- }
223
- /**
224
- * Arguments for the "edit.add-features", "edit.update-features" and
225
- * "edit.delete-features" commands. Web only.
226
- */
227
- export interface EditCommandArgs extends HasFeatures {
228
- /**
229
- * Whether to show UI notifications. Will default to `true`.
230
- */
231
- showNotifications?: boolean;
232
- }
233
- export declare class EditCommands extends CommandRegistry {
234
- protected readonly _prefix = "edit";
235
- /**
236
- * Create and add an attachment to a provided feature, using the given
237
- * attachment data.
238
- */
239
- get addAttachment(): Command<AddAttachmentArgs | WebAddAttachmentArgs>;
240
- /**
241
- * Deletes attachments from feature(s).
242
- */
243
- get deleteAttachment(): Command<DeleteAttachmentArgs>;
244
- /**
245
- * Adds a feature to a particular layer. `Features` and `EditCommandArgs`
246
- * are not supported on Mobile.
247
- */
248
- get addFeature(): Command<Feature | Features | EditCommandArgs>;
249
- /**
250
- * Cancels active editing sessions and discards any changes. If a feature is
251
- * supplied only the sessions using that feature will be cancelled. Web
252
- * only.
253
- *
254
- * @webOnly
255
- */
256
- get cancel(): Command<Features>;
257
- /**
258
- * Completes active editing sessions and submits any changes made to the
259
- * attributes, attachments or geometry to the feature source. If a feature
260
- * is supplied, only sessions using that feature will close. Web only.
261
- *
262
- * @webOnly
263
- */
264
- get complete(): Command<Features>;
265
- /**
266
- * Deletes the given feature or features from their feature sources.
267
- * `EditCommandArgs` is not supported on Mobile.
268
- */
269
- get deleteFeatures(): Command<Features | EditCommandArgs>;
270
- /**
271
- * Begin an interactive feature editing session with a new feature.
272
- * `DisplayAddFeatureArgs` is not supported on Mobile.
273
- */
274
- get displayAddFeature(): Command<FeatureSource | DisplayAddFeatureArgs>;
275
- /**
276
- * Begin an interactive feature editing session for a new related feature.
277
- * The specified feature will be the original feature that the new related
278
- * feature will be added to in the relationship.
279
- */
280
- get displayAddRelatedFeature(): Command<DisplayAddRelatedFeatureArgs>;
281
- /**
282
- * Begin an interactive feature editing session with an existing feature.
283
- * `DisplayUpdateFeatureArgs` is not supported on Mobile.
284
- */
285
- get displayUpdateFeature(): Command<Feature | DisplayUpdateFeatureArgs>;
286
- /**
287
- * Updates a layer feature or features. Edits to the geometry and attributes
288
- * of the supplied features will be committed to their respective feature
289
- * sources. `Features` and `EditCommandArgs` are not supported on Mobile.
290
- */
291
- get updateFeature(): Command<Feature | Features | EditCommandArgs>;
292
- /**
293
- * Updates an in-progress interactive feature editing session with new
294
- * attributes, attachments, or geometry. These will be immediately applied
295
- * to the current session, if one is active. Web only.
296
- *
297
- * @webOnly
298
- */
299
- get updateSession(): Command<UpdateSessionArgs>;
300
- /**
301
- * Clears a feature's GNSS metadata. This command will clear the well known
302
- * GNSS attributes, such as "esrignss_longitude" and "esrignss_latitude".
303
- *
304
- * @mobileOnly
305
- */
306
- get clearGnssMetadata(): Command<Feature>;
307
- }
308
- export declare class EditOperations extends OperationRegistry {
309
- protected readonly _prefix = "edit";
310
- /**
311
- * Creates a new feature for the supplied feature source from the supplied
312
- * configuration. This operation does not add the feature to the source, but
313
- * returns the feature for further processing. Web only.
314
- *
315
- * @webOnly
316
- */
317
- get createFeature(): Operation<CreateFeatureArgs, HasFeatures>;
318
- /**
319
- * Automatically populates the well known GNSS attributes from the current
320
- * location data. Examples of well known GNSS attributes are
321
- * "esrignss_longitude" and "esrignss_latitude". The input feature argument
322
- * may be null, in which case a new feature will be created. Returns the
323
- * input feature, or a new feature if one was created.
324
- *
325
- * @mobileOnly
326
- */
327
- get updateGnssMetadata(): Operation<Feature, Feature>;
328
- }
329
- export declare class EditEvents extends EventRegistry {
330
- protected readonly _prefix = "edit";
331
- /**
332
- * Raised when an attachment is added to a feature. Mobile only.
333
- *
334
- * @mobileOnly
335
- */
336
- get attachmentAdded(): Event<AttachmentEventArgs>;
337
- /**
338
- * Raised when an attachment is updated. Mobile only.
339
- *
340
- * @mobileOnly
341
- */
342
- get attachmentUpdated(): Event<AttachmentEventArgs>;
343
- /**
344
- * Raised when an attachment is deleted from a feature. Mobile only.
345
- *
346
- * @mobileOnly
347
- */
348
- get attachmentDeleted(): Event<AttachmentEventArgs>;
349
- /**
350
- * Raised when a new feature is added to a feature source.
351
- */
352
- get featureAdded(): Event<Feature>;
353
- /**
354
- * Raised when a feature is deleted from a feature source.
355
- */
356
- get featureDeleted(): Event<Feature>;
357
- /**
358
- * Raised when the attributes or geometry of a feature from a feature source
359
- * are updated.
360
- */
361
- get featureUpdated(): Event<Feature>;
362
- /**
363
- * Raised when an interactive feature editing session is updated with new
364
- * attributes, attachments, or feature geometry. The payload of this event
365
- * represents the current state of that session and has not yet been applied
366
- * to the feature. Web only.
367
- *
368
- * @webOnly
369
- */
370
- get sessionUpdated(): Event<UpdateSessionArgs>;
371
- }
1
+ import type FieldElement from "@arcgis/core/form/elements/FieldElement.js";
2
+ import type { Attachment } from "@vertigis/arcgis-extensions/data/Attachment";
3
+ import type { Feature } from "@vertigis/arcgis-extensions/data/Feature";
4
+ import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource";
5
+ import type { Command } from "../Command.js";
6
+ import { CommandRegistry } from "../CommandRegistry.js";
7
+ import type { Event } from "../Event.js";
8
+ import { EventRegistry } from "../EventRegistry.js";
9
+ import type { Operation } from "../Operation.js";
10
+ import { OperationRegistry } from "../OperationRegistry.js";
11
+ import type { Features, File, HasFeatures, HasGeometry, HasLayers, HasMaps, HasUITarget, MapsLike } from "../common.js";
12
+ import type { EditGeometryOptions } from "./sketching.js";
13
+ /**
14
+ * Arguments for the "edit.add-attachment" command. Supported by both Web and
15
+ * Mobile.
16
+ */
17
+ export interface AddAttachmentArgs {
18
+ /**
19
+ * The map.
20
+ */
21
+ maps: MapsLike;
22
+ /**
23
+ * The feature(s) to add the attachment to.
24
+ */
25
+ features: Feature[];
26
+ /**
27
+ * The name of the attachment.
28
+ */
29
+ name: string;
30
+ /**
31
+ * The MIME content type of the attachment.
32
+ */
33
+ contentType: string;
34
+ /**
35
+ * The binary data for the attachment.
36
+ */
37
+ data: number[];
38
+ }
39
+ /**
40
+ * VertiGIS Studio Web's arguments for the "edit.add-attachment" command. Not
41
+ * supported by Mobile.
42
+ */
43
+ export interface WebAddAttachmentArgs {
44
+ /**
45
+ * The feature(s) to add the attachment(s) to. If multiple features are
46
+ * specified, the attachment(s) will be added to all features.
47
+ */
48
+ features: Features;
49
+ /**
50
+ * The blob(s) that contains the file attachment(s). If multiple attachments
51
+ * are specified, all attachment will be added to the feature(s).
52
+ */
53
+ blobs: File | File[];
54
+ }
55
+ /**
56
+ * Arguments for the "edit.delete-attachment" command.
57
+ */
58
+ export interface DeleteAttachmentArgs {
59
+ /**
60
+ * The feature(s) to remove the attachment(s) from.
61
+ */
62
+ features: Features;
63
+ /**
64
+ * The attachment(s) to remove from the feature(s). This property can be
65
+ * populated with the title(s) or ID(s) of the attachments(s). Any and all
66
+ * matching attachments found on the input features will be deleted. Web
67
+ * only.
68
+ */
69
+ attachments?: string[];
70
+ /**
71
+ * The attachment to remove from the feature(s). Mobile only.
72
+ */
73
+ gcxAttachment?: Attachment;
74
+ }
75
+ /**
76
+ * Arguments for various attachment events.
77
+ */
78
+ export interface AttachmentEventArgs {
79
+ /**
80
+ * The feature that had an attachment added/updated/deleted.
81
+ */
82
+ feature: Feature;
83
+ /**
84
+ * The attachment that was added/updated/deleted.
85
+ */
86
+ attachment: Attachment;
87
+ }
88
+ /**
89
+ * A collection of options common to interactive feature editing sessions. Web
90
+ * only.
91
+ */
92
+ export interface EditOptions {
93
+ /**
94
+ * Whether to show UI notifications. Defaults to `true`.
95
+ */
96
+ showNotifications?: boolean;
97
+ /**
98
+ * The orientation of the template picker. Defaults to "vertical".
99
+ */
100
+ orientation?: "horizontal" | "vertical";
101
+ /**
102
+ * Whether to show titles on the template picker. Defaults to `true`.
103
+ */
104
+ showTitles?: boolean;
105
+ /**
106
+ * Whether to allow editing of feature geometry.
107
+ */
108
+ editGeometry?: boolean;
109
+ /**
110
+ * Whether to allow editing of feature attributes.
111
+ */
112
+ editAttributes?: boolean;
113
+ /**
114
+ * Whether to allow editing of feature attachments.
115
+ */
116
+ editAttachments?: boolean;
117
+ /**
118
+ * Options for the geometry editing session.
119
+ */
120
+ editGeometryOptions?: EditGeometryOptions;
121
+ /**
122
+ * Web only. Additional settings that are specific to sketching plugins,
123
+ * keyed by plugin ID. The only currently supported plugin is "snapping". A
124
+ * boolean value can also be assigned to completely disable, or enable with
125
+ * default settings.
126
+ */
127
+ pluginSettings?: Record<string, boolean | Record<string, unknown>>;
128
+ }
129
+ /**
130
+ * Used to update an in-progress interactive feature editing session with new
131
+ * attributes, attachments or geometry. Web only.
132
+ */
133
+ export interface UpdateSessionArgs extends HasGeometry {
134
+ /**
135
+ * A collection of attributes that apply or are to be applied to the
136
+ * currently edited feature.
137
+ */
138
+ attributes?: Record<string, string | number>;
139
+ /**
140
+ * A collection of attachments that apply or are to be applied to the
141
+ * currently edited feature.
142
+ */
143
+ attachments?: Attachment[];
144
+ }
145
+ /**
146
+ * Arguments for the "edit.create-feature" operation. A valid feature layer,
147
+ * subtype group layer, or subtype sublayer is required. The geometry is
148
+ * required for non-tabular features. Web only.
149
+ */
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;
163
+ /**
164
+ * A collection of attributes to apply to the new feature.
165
+ */
166
+ featureAttributes?: Record<string, unknown>;
167
+ /**
168
+ * The template to use as a starting point for this feature. Requires a
169
+ * layer. The default or first template will be used if not set.
170
+ */
171
+ templateName?: string;
172
+ /**
173
+ * A type id to use as a starting point for this feature. This may return
174
+ * one or more templates and requires a layer with types defined.
175
+ */
176
+ typeId?: string;
177
+ }
178
+ /**
179
+ * Arguments for the "edit.display-add-feature" command. Web only.
180
+ */
181
+ export interface DisplayAddFeatureArgs extends CreateFeatureArgs, HasMaps, EditOptions {
182
+ /**
183
+ * Arguments for the display of the attribute editing form. Web only.
184
+ */
185
+ formUITarget?: HasUITarget;
186
+ /**
187
+ * Arguments for the display of the template picker. Web only.
188
+ */
189
+ templateUITarget?: HasUITarget;
190
+ /**
191
+ * A collection of configuration overrides for the editable fields. Web
192
+ * only.
193
+ */
194
+ fieldElements?: Partial<FieldElement>[];
195
+ }
196
+ /**
197
+ * Arguments for the "edit.display-add-related-feature" command. A feature and a
198
+ * relationship ID are supplied as inputs instead of a layer.
199
+ */
200
+ export interface DisplayAddRelatedFeatureArgs extends Omit<DisplayAddFeatureArgs, "layers">, HasFeatures {
201
+ /**
202
+ * The ID of the relationship to add a feature to.
203
+ */
204
+ relationshipId: string;
205
+ /**
206
+ * The feature source for the related feature to create. Mobile only.
207
+ */
208
+ relatedFeatureSource: FeatureSource;
209
+ }
210
+ /**
211
+ * Arguments for the "edit.display-update-features" operation. Web only.
212
+ */
213
+ export interface DisplayUpdateFeatureArgs extends EditCommandArgs, HasGeometry, HasMaps, HasUITarget, EditOptions {
214
+ /**
215
+ * A collection of attributes to automatically apply to the updated feature.
216
+ */
217
+ featureAttributes?: Record<string, unknown>;
218
+ /**
219
+ * A collection of configuration overrides for the editable fields.
220
+ */
221
+ fieldElements?: Partial<FieldElement>[];
222
+ }
223
+ /**
224
+ * Arguments for the "edit.add-features", "edit.update-features" and
225
+ * "edit.delete-features" commands. Web only.
226
+ */
227
+ export interface EditCommandArgs extends HasFeatures {
228
+ /**
229
+ * Whether to show UI notifications. Will default to `true`.
230
+ */
231
+ showNotifications?: boolean;
232
+ }
233
+ export declare class EditCommands extends CommandRegistry {
234
+ protected readonly _prefix = "edit";
235
+ /**
236
+ * Create and add an attachment to a provided feature, using the given
237
+ * attachment data.
238
+ */
239
+ get addAttachment(): Command<AddAttachmentArgs | WebAddAttachmentArgs>;
240
+ /**
241
+ * Deletes attachments from feature(s).
242
+ */
243
+ get deleteAttachment(): Command<DeleteAttachmentArgs>;
244
+ /**
245
+ * Adds a feature to a particular layer. `Features` and `EditCommandArgs`
246
+ * are not supported on Mobile.
247
+ */
248
+ get addFeature(): Command<Feature | Features | EditCommandArgs>;
249
+ /**
250
+ * Cancels active editing sessions and discards any changes. If a feature is
251
+ * supplied only the sessions using that feature will be cancelled. Web
252
+ * only.
253
+ *
254
+ * @webOnly
255
+ */
256
+ get cancel(): Command<Features>;
257
+ /**
258
+ * Completes active editing sessions and submits any changes made to the
259
+ * attributes, attachments or geometry to the feature source. If a feature
260
+ * is supplied, only sessions using that feature will close. Web only.
261
+ *
262
+ * @webOnly
263
+ */
264
+ get complete(): Command<Features>;
265
+ /**
266
+ * Deletes the given feature or features from their feature sources.
267
+ * `EditCommandArgs` is not supported on Mobile.
268
+ */
269
+ get deleteFeatures(): Command<Features | EditCommandArgs>;
270
+ /**
271
+ * Begin an interactive feature editing session with a new feature.
272
+ * `DisplayAddFeatureArgs` is not supported on Mobile.
273
+ */
274
+ get displayAddFeature(): Command<FeatureSource | DisplayAddFeatureArgs>;
275
+ /**
276
+ * Begin an interactive feature editing session for a new related feature.
277
+ * The specified feature will be the original feature that the new related
278
+ * feature will be added to in the relationship.
279
+ */
280
+ get displayAddRelatedFeature(): Command<DisplayAddRelatedFeatureArgs>;
281
+ /**
282
+ * Begin an interactive feature editing session with an existing feature.
283
+ * `DisplayUpdateFeatureArgs` is not supported on Mobile.
284
+ */
285
+ get displayUpdateFeature(): Command<Feature | DisplayUpdateFeatureArgs>;
286
+ /**
287
+ * Updates a layer feature or features. Edits to the geometry and attributes
288
+ * of the supplied features will be committed to their respective feature
289
+ * sources. `Features` and `EditCommandArgs` are not supported on Mobile.
290
+ */
291
+ get updateFeature(): Command<Feature | Features | EditCommandArgs>;
292
+ /**
293
+ * Updates an in-progress interactive feature editing session with new
294
+ * attributes, attachments, or geometry. These will be immediately applied
295
+ * to the current session, if one is active. Web only.
296
+ *
297
+ * @webOnly
298
+ */
299
+ get updateSession(): Command<UpdateSessionArgs>;
300
+ /**
301
+ * Clears a feature's GNSS metadata. This command will clear the well known
302
+ * GNSS attributes, such as "esrignss_longitude" and "esrignss_latitude".
303
+ *
304
+ * @mobileOnly
305
+ */
306
+ get clearGnssMetadata(): Command<Feature>;
307
+ }
308
+ export declare class EditOperations extends OperationRegistry {
309
+ protected readonly _prefix = "edit";
310
+ /**
311
+ * Creates a new feature for the supplied feature source from the supplied
312
+ * configuration. This operation does not add the feature to the source, but
313
+ * returns the feature for further processing. Web only.
314
+ *
315
+ * @webOnly
316
+ */
317
+ get createFeature(): Operation<CreateFeatureArgs, HasFeatures>;
318
+ /**
319
+ * Automatically populates the well known GNSS attributes from the current
320
+ * location data. Examples of well known GNSS attributes are
321
+ * "esrignss_longitude" and "esrignss_latitude". The input feature argument
322
+ * may be null, in which case a new feature will be created. Returns the
323
+ * input feature, or a new feature if one was created.
324
+ *
325
+ * @mobileOnly
326
+ */
327
+ get updateGnssMetadata(): Operation<Feature, Feature>;
328
+ }
329
+ export declare class EditEvents extends EventRegistry {
330
+ protected readonly _prefix = "edit";
331
+ /**
332
+ * Raised when an attachment is added to a feature. Mobile only.
333
+ *
334
+ * @mobileOnly
335
+ */
336
+ get attachmentAdded(): Event<AttachmentEventArgs>;
337
+ /**
338
+ * Raised when an attachment is updated. Mobile only.
339
+ *
340
+ * @mobileOnly
341
+ */
342
+ get attachmentUpdated(): Event<AttachmentEventArgs>;
343
+ /**
344
+ * Raised when an attachment is deleted from a feature. Mobile only.
345
+ *
346
+ * @mobileOnly
347
+ */
348
+ get attachmentDeleted(): Event<AttachmentEventArgs>;
349
+ /**
350
+ * Raised when a new feature is added to a feature source.
351
+ */
352
+ get featureAdded(): Event<Feature>;
353
+ /**
354
+ * Raised when a feature is deleted from a feature source.
355
+ */
356
+ get featureDeleted(): Event<Feature>;
357
+ /**
358
+ * Raised when the attributes or geometry of a feature from a feature source
359
+ * are updated.
360
+ */
361
+ get featureUpdated(): Event<Feature>;
362
+ /**
363
+ * Raised when an interactive feature editing session is updated with new
364
+ * attributes, attachments, or feature geometry. The payload of this event
365
+ * represents the current state of that session and has not yet been applied
366
+ * to the feature. Web only.
367
+ *
368
+ * @webOnly
369
+ */
370
+ get sessionUpdated(): Event<UpdateSessionArgs>;
371
+ }