@vertigis/viewer-spec 56.23.0 → 56.25.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 (267) 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 +87 -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/UserModelProperties.d.ts +12 -12
  128. package/app-config/web/UserPreferencesModelProperties.d.ts +10 -10
  129. package/app-config/web/VertigisWebModelProperties.d.ts +74 -74
  130. package/app-config/web/WorkflowModelProperties.d.ts +13 -13
  131. package/app-config/web/ZoomModelProperties.d.ts +7 -7
  132. package/layout/schema/layout-common.xsd +20 -7
  133. package/messaging/Command.d.ts +76 -76
  134. package/messaging/CommandRegistry.d.ts +25 -25
  135. package/messaging/CommandRegistry.js +1 -1
  136. package/messaging/DotNetTypes.d.ts +4 -4
  137. package/messaging/Event.d.ts +26 -26
  138. package/messaging/EventRegistry.d.ts +25 -25
  139. package/messaging/EventRegistry.js +1 -1
  140. package/messaging/Message.d.ts +50 -50
  141. package/messaging/MessageBus.d.ts +54 -54
  142. package/messaging/Operation.d.ts +77 -77
  143. package/messaging/OperationRegistry.d.ts +26 -26
  144. package/messaging/OperationRegistry.js +1 -1
  145. package/messaging/common.d.ts +354 -354
  146. package/messaging/mobile.d.ts +6 -6
  147. package/messaging/registry/Commands.d.ts +78 -78
  148. package/messaging/registry/Commands.js +1 -1
  149. package/messaging/registry/Events.d.ts +62 -62
  150. package/messaging/registry/Events.js +1 -1
  151. package/messaging/registry/Operations.d.ts +69 -69
  152. package/messaging/registry/Operations.js +1 -1
  153. package/messaging/registry/app-config.d.ts +12 -12
  154. package/messaging/registry/app-config.js +1 -1
  155. package/messaging/registry/app.d.ts +264 -264
  156. package/messaging/registry/app.js +1 -1
  157. package/messaging/registry/arcade.d.ts +115 -115
  158. package/messaging/registry/arcade.js +1 -1
  159. package/messaging/registry/auth.d.ts +151 -151
  160. package/messaging/registry/auth.js +1 -1
  161. package/messaging/registry/basemap.d.ts +74 -74
  162. package/messaging/registry/basemap.js +1 -1
  163. package/messaging/registry/bookmark.d.ts +42 -42
  164. package/messaging/registry/bookmark.js +1 -1
  165. package/messaging/registry/charts.d.ts +81 -81
  166. package/messaging/registry/charts.js +1 -1
  167. package/messaging/registry/debugConsole.d.ts +26 -26
  168. package/messaging/registry/debugConsole.js +1 -1
  169. package/messaging/registry/device.d.ts +28 -28
  170. package/messaging/registry/device.js +1 -1
  171. package/messaging/registry/display.d.ts +17 -17
  172. package/messaging/registry/display.js +1 -1
  173. package/messaging/registry/drawing.d.ts +149 -149
  174. package/messaging/registry/drawing.js +1 -1
  175. package/messaging/registry/edit.d.ts +371 -371
  176. package/messaging/registry/edit.js +1 -1
  177. package/messaging/registry/file.d.ts +156 -156
  178. package/messaging/registry/file.js +1 -1
  179. package/messaging/registry/filter-builder.d.ts +73 -73
  180. package/messaging/registry/filter-builder.js +1 -1
  181. package/messaging/registry/geocode.d.ts +87 -87
  182. package/messaging/registry/geocode.js +1 -1
  183. package/messaging/registry/geolocation.d.ts +499 -499
  184. package/messaging/registry/geolocation.js +1 -1
  185. package/messaging/registry/geometry-toolbar.d.ts +29 -29
  186. package/messaging/registry/geometry-toolbar.js +1 -1
  187. package/messaging/registry/geometry.d.ts +278 -278
  188. package/messaging/registry/geometry.js +1 -1
  189. package/messaging/registry/highlights.d.ts +86 -86
  190. package/messaging/registry/highlights.js +1 -1
  191. package/messaging/registry/input.d.ts +22 -22
  192. package/messaging/registry/input.js +1 -1
  193. package/messaging/registry/iwtm.d.ts +11 -11
  194. package/messaging/registry/iwtm.js +1 -1
  195. package/messaging/registry/kpi.d.ts +98 -98
  196. package/messaging/registry/kpi.js +1 -1
  197. package/messaging/registry/layer-comparison.d.ts +104 -104
  198. package/messaging/registry/layer-comparison.js +1 -1
  199. package/messaging/registry/layer-presets.d.ts +49 -49
  200. package/messaging/registry/layer-presets.js +1 -1
  201. package/messaging/registry/layers.d.ts +196 -196
  202. package/messaging/registry/layers.js +1 -1
  203. package/messaging/registry/layout.d.ts +49 -49
  204. package/messaging/registry/layout.js +1 -1
  205. package/messaging/registry/licensing.d.ts +38 -38
  206. package/messaging/registry/licensing.js +1 -1
  207. package/messaging/registry/location-marker.d.ts +171 -171
  208. package/messaging/registry/location-marker.js +1 -1
  209. package/messaging/registry/logViewer.d.ts +17 -17
  210. package/messaging/registry/logViewer.js +1 -1
  211. package/messaging/registry/map.d.ts +1275 -1275
  212. package/messaging/registry/map.js +1 -1
  213. package/messaging/registry/measurement.d.ts +168 -168
  214. package/messaging/registry/measurement.js +1 -1
  215. package/messaging/registry/messaging.d.ts +23 -23
  216. package/messaging/registry/messaging.js +1 -1
  217. package/messaging/registry/network.d.ts +46 -46
  218. package/messaging/registry/network.js +1 -1
  219. package/messaging/registry/offline.d.ts +508 -507
  220. package/messaging/registry/offline.js +1 -1
  221. package/messaging/registry/panel.d.ts +115 -115
  222. package/messaging/registry/panel.js +1 -1
  223. package/messaging/registry/photos.d.ts +47 -47
  224. package/messaging/registry/photos.js +1 -1
  225. package/messaging/registry/portal.d.ts +94 -94
  226. package/messaging/registry/portal.js +1 -1
  227. package/messaging/registry/printing.d.ts +166 -166
  228. package/messaging/registry/printing.js +1 -1
  229. package/messaging/registry/project.d.ts +144 -144
  230. package/messaging/registry/project.js +1 -1
  231. package/messaging/registry/query-builder.d.ts +83 -83
  232. package/messaging/registry/query-builder.js +1 -1
  233. package/messaging/registry/region.d.ts +23 -23
  234. package/messaging/registry/region.js +1 -1
  235. package/messaging/registry/reports.d.ts +135 -135
  236. package/messaging/registry/reports.js +1 -1
  237. package/messaging/registry/results.d.ts +671 -671
  238. package/messaging/registry/results.js +1 -1
  239. package/messaging/registry/search.d.ts +74 -74
  240. package/messaging/registry/search.js +1 -1
  241. package/messaging/registry/settings.d.ts +38 -38
  242. package/messaging/registry/settings.js +1 -1
  243. package/messaging/registry/shortcut.d.ts +41 -41
  244. package/messaging/registry/shortcut.js +1 -1
  245. package/messaging/registry/sketching.d.ts +960 -960
  246. package/messaging/registry/sketching.js +1 -1
  247. package/messaging/registry/studioAnalytics.d.ts +25 -25
  248. package/messaging/registry/studioAnalytics.js +1 -1
  249. package/messaging/registry/system.d.ts +277 -277
  250. package/messaging/registry/system.js +1 -1
  251. package/messaging/registry/tasks.d.ts +323 -323
  252. package/messaging/registry/tasks.js +1 -1
  253. package/messaging/registry/ui.d.ts +518 -518
  254. package/messaging/registry/ui.js +1 -1
  255. package/messaging/registry/viewer.d.ts +145 -145
  256. package/messaging/registry/viewer.js +1 -1
  257. package/messaging/registry/workflow.d.ts +170 -170
  258. package/messaging/registry/workflow.js +1 -1
  259. package/messaging/schema/common-action.schema.json +6437 -12158
  260. package/messaging/schema/common-event.schema.json +107 -803
  261. package/messaging/schema/mobile-action.schema.json +7719 -16138
  262. package/messaging/schema/mobile-event.schema.json +181 -2422
  263. package/messaging/schema/web-action.schema.json +8397 -23281
  264. package/messaging/schema/web-event.schema.json +183 -1937
  265. package/package.json +20 -20
  266. package/version.d.ts +4 -4
  267. package/version.js +4 -4
@@ -1 +1 @@
1
- import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export class EditCommands extends e{constructor(){super(...arguments),this._prefix="edit"}get addAttachment(){return this._get("add-attachment")}get deleteAttachment(){return this._get("delete-attachment")}get addFeature(){return this._get("add-feature")}get cancel(){return this._get("cancel")}get complete(){return this._get("complete")}get deleteFeatures(){return this._get("delete-features")}get displayAddFeature(){return this._get("display-add-feature")}get displayAddRelatedFeature(){return this._get("display-add-related-feature")}get displayUpdateFeature(){return this._get("display-update-feature")}get updateFeature(){return this._get("update-feature")}get updateSession(){return this._get("update-session")}get clearGnssMetadata(){return this._get("clear-gnss-metadata")}}export class EditOperations extends a{constructor(){super(...arguments),this._prefix="edit"}get createFeature(){return this._get("create-feature")}get updateGnssMetadata(){return this._get("update-gnss-metadata")}}export class EditEvents extends t{constructor(){super(...arguments),this._prefix="edit"}get attachmentAdded(){return this._get("attachment-added")}get attachmentUpdated(){return this._get("attachment-updated")}get attachmentDeleted(){return this._get("attachment-deleted")}get featureAdded(){return this._get("feature-added")}get featureDeleted(){return this._get("feature-deleted")}get featureUpdated(){return this._get("feature-updated")}get sessionUpdated(){return this._get("session-updated")}}
1
+ import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as a}from"../OperationRegistry.js";export class EditCommands extends e{_prefix="edit";get addAttachment(){return this._get("add-attachment")}get deleteAttachment(){return this._get("delete-attachment")}get addFeature(){return this._get("add-feature")}get cancel(){return this._get("cancel")}get complete(){return this._get("complete")}get deleteFeatures(){return this._get("delete-features")}get displayAddFeature(){return this._get("display-add-feature")}get displayAddRelatedFeature(){return this._get("display-add-related-feature")}get displayUpdateFeature(){return this._get("display-update-feature")}get updateFeature(){return this._get("update-feature")}get updateSession(){return this._get("update-session")}get clearGnssMetadata(){return this._get("clear-gnss-metadata")}}export class EditOperations extends a{_prefix="edit";get createFeature(){return this._get("create-feature")}get updateGnssMetadata(){return this._get("update-gnss-metadata")}}export class EditEvents extends t{_prefix="edit";get attachmentAdded(){return this._get("attachment-added")}get attachmentUpdated(){return this._get("attachment-updated")}get attachmentDeleted(){return this._get("attachment-deleted")}get featureAdded(){return this._get("feature-added")}get featureDeleted(){return this._get("feature-deleted")}get featureUpdated(){return this._get("feature-updated")}get sessionUpdated(){return this._get("session-updated")}}
@@ -1,156 +1,156 @@
1
- /// <reference types="dotnet-bcl" />
2
- import type PortalItem from "@arcgis/core/portal/PortalItem.js";
3
- import type Exception from "dotnet-bcl/System/Exception";
4
- import type { Command } from "../Command.js";
5
- import { CommandRegistry } from "../CommandRegistry.js";
6
- import type { Event } from "../Event.js";
7
- import { EventRegistry } from "../EventRegistry.js";
8
- import type { Operation } from "../Operation.js";
9
- import { OperationRegistry } from "../OperationRegistry.js";
10
- /**
11
- * A type of attachment.
12
- */
13
- export type AttachmentType = "File" | "Media";
14
- /**
15
- * The binary contents of the attachment.
16
- */
17
- export interface EnhancedFileData {
18
- }
19
- /**
20
- * Arguments to pick a file.
21
- */
22
- export interface PickFileArgs {
23
- /**
24
- * Type of the attachment used to pick a file. Mobile only.
25
- *
26
- * @mobileOnly
27
- */
28
- attachmentType: AttachmentType;
29
- /**
30
- * Allowed types of file used to pick a file. Mobile only.
31
- *
32
- * @mobileOnly
33
- */
34
- allowedFileTypes: string[];
35
- }
36
- /**
37
- * Arguments to open a file.
38
- */
39
- export interface OpenFileArgs {
40
- /**
41
- * Name of the file to open. Mobile only.
42
- *
43
- * @mobileOnly
44
- */
45
- fileName: string;
46
- }
47
- /**
48
- * Information about a file download.
49
- */
50
- export interface FileDownloadInfo {
51
- /**
52
- * The portal item from which this file is being downloaded.
53
- */
54
- portalItem: PortalItem;
55
- /**
56
- * The full path of the file being downloaded.
57
- */
58
- filePath: string;
59
- /**
60
- * A value indicating whether this download is updating a file. If true, it
61
- * means that the file already existed on disk and a new version is being
62
- * downloaded.
63
- */
64
- isUpdating: boolean;
65
- }
66
- /**
67
- * Arguments for the 'file.download-started' event.
68
- */
69
- export interface FileDownloadStartedEventArgs {
70
- /**
71
- * The collection of FileDownloadInfos describing the file downloads that
72
- * have started.
73
- */
74
- fileDownloadInfos: FileDownloadInfo[];
75
- }
76
- /**
77
- * The status of a portal item download job.
78
- */
79
- export type PortalItemDownloadJobStatus =
80
- /**
81
- * Job is not started; either newly created or previously cancelled.
82
- */
83
- "NotStarted"
84
- /**
85
- * Download is in progress.
86
- */
87
- | "InProgress"
88
- /**
89
- * Download has been interrupted.
90
- */
91
- | "Interrupted"
92
- /**
93
- * Download has completed successfully.
94
- */
95
- | "Completed"
96
- /**
97
- * The job has failed.
98
- */
99
- | "Failed";
100
- /**
101
- * Arguments for the "file.download-ended" event.
102
- */
103
- export interface FileDownloadEndedEventArgs extends FileDownloadInfo {
104
- /**
105
- * The status of the file download.
106
- */
107
- status: PortalItemDownloadJobStatus;
108
- /**
109
- * The exception that occurred during the file download.
110
- */
111
- exception?: Exception;
112
- /**
113
- * The duration of the download, in milliseconds.
114
- */
115
- downloadDuration: number;
116
- }
117
- export declare class FileOperations extends OperationRegistry {
118
- protected readonly _prefix = "file";
119
- /**
120
- * Prompt the user to select a file from the file system, and return the
121
- * resulting data. Mobile only.
122
- *
123
- * @mobileOnly
124
- */
125
- get pickFile(): Operation<PickFileArgs, EnhancedFileData>;
126
- }
127
- export declare class FileCommands extends CommandRegistry {
128
- protected readonly _prefix = "file";
129
- /**
130
- * Opens a file in an app assigned to the file type. Mobile only.
131
- *
132
- * @mobileOnly
133
- */
134
- get openFile(): Command<OpenFileArgs | string>;
135
- }
136
- export declare class FileEvents extends EventRegistry {
137
- protected readonly _prefix = "file";
138
- /**
139
- * Raised when a file is opened. Mobile only.
140
- *
141
- * @mobileOnly
142
- */
143
- get opened(): Event<OpenFileArgs>;
144
- /**
145
- * Raised when a file download starts or resumes. Mobile only.
146
- *
147
- * @mobileOnly
148
- */
149
- get downloadStarted(): Event<FileDownloadStartedEventArgs>;
150
- /**
151
- * Raised when a file download ends. Mobile only.
152
- *
153
- * @mobileOnly
154
- */
155
- get downloadEnded(): Event<FileDownloadEndedEventArgs>;
156
- }
1
+ /// <reference types="dotnet-bcl" />
2
+ import type PortalItem from "@arcgis/core/portal/PortalItem.js";
3
+ import type Exception from "dotnet-bcl/System/Exception";
4
+ import type { Command } from "../Command.js";
5
+ import { CommandRegistry } from "../CommandRegistry.js";
6
+ import type { Event } from "../Event.js";
7
+ import { EventRegistry } from "../EventRegistry.js";
8
+ import type { Operation } from "../Operation.js";
9
+ import { OperationRegistry } from "../OperationRegistry.js";
10
+ /**
11
+ * A type of attachment.
12
+ */
13
+ export type AttachmentType = "File" | "Media";
14
+ /**
15
+ * The binary contents of the attachment.
16
+ */
17
+ export interface EnhancedFileData {
18
+ }
19
+ /**
20
+ * Arguments to pick a file.
21
+ */
22
+ export interface PickFileArgs {
23
+ /**
24
+ * Type of the attachment used to pick a file. Mobile only.
25
+ *
26
+ * @mobileOnly
27
+ */
28
+ attachmentType: AttachmentType;
29
+ /**
30
+ * Allowed types of file used to pick a file. Mobile only.
31
+ *
32
+ * @mobileOnly
33
+ */
34
+ allowedFileTypes: string[];
35
+ }
36
+ /**
37
+ * Arguments to open a file.
38
+ */
39
+ export interface OpenFileArgs {
40
+ /**
41
+ * Name of the file to open. Mobile only.
42
+ *
43
+ * @mobileOnly
44
+ */
45
+ fileName: string;
46
+ }
47
+ /**
48
+ * Information about a file download.
49
+ */
50
+ export interface FileDownloadInfo {
51
+ /**
52
+ * The portal item from which this file is being downloaded.
53
+ */
54
+ portalItem: PortalItem;
55
+ /**
56
+ * The full path of the file being downloaded.
57
+ */
58
+ filePath: string;
59
+ /**
60
+ * A value indicating whether this download is updating a file. If true, it
61
+ * means that the file already existed on disk and a new version is being
62
+ * downloaded.
63
+ */
64
+ isUpdating: boolean;
65
+ }
66
+ /**
67
+ * Arguments for the 'file.download-started' event.
68
+ */
69
+ export interface FileDownloadStartedEventArgs {
70
+ /**
71
+ * The collection of FileDownloadInfos describing the file downloads that
72
+ * have started.
73
+ */
74
+ fileDownloadInfos: FileDownloadInfo[];
75
+ }
76
+ /**
77
+ * The status of a portal item download job.
78
+ */
79
+ export type PortalItemDownloadJobStatus =
80
+ /**
81
+ * Job is not started; either newly created or previously cancelled.
82
+ */
83
+ "NotStarted"
84
+ /**
85
+ * Download is in progress.
86
+ */
87
+ | "InProgress"
88
+ /**
89
+ * Download has been interrupted.
90
+ */
91
+ | "Interrupted"
92
+ /**
93
+ * Download has completed successfully.
94
+ */
95
+ | "Completed"
96
+ /**
97
+ * The job has failed.
98
+ */
99
+ | "Failed";
100
+ /**
101
+ * Arguments for the "file.download-ended" event.
102
+ */
103
+ export interface FileDownloadEndedEventArgs extends FileDownloadInfo {
104
+ /**
105
+ * The status of the file download.
106
+ */
107
+ status: PortalItemDownloadJobStatus;
108
+ /**
109
+ * The exception that occurred during the file download.
110
+ */
111
+ exception?: Exception;
112
+ /**
113
+ * The duration of the download, in milliseconds.
114
+ */
115
+ downloadDuration: number;
116
+ }
117
+ export declare class FileOperations extends OperationRegistry {
118
+ protected readonly _prefix = "file";
119
+ /**
120
+ * Prompt the user to select a file from the file system, and return the
121
+ * resulting data. Mobile only.
122
+ *
123
+ * @mobileOnly
124
+ */
125
+ get pickFile(): Operation<PickFileArgs, EnhancedFileData>;
126
+ }
127
+ export declare class FileCommands extends CommandRegistry {
128
+ protected readonly _prefix = "file";
129
+ /**
130
+ * Opens a file in an app assigned to the file type. Mobile only.
131
+ *
132
+ * @mobileOnly
133
+ */
134
+ get openFile(): Command<OpenFileArgs | string>;
135
+ }
136
+ export declare class FileEvents extends EventRegistry {
137
+ protected readonly _prefix = "file";
138
+ /**
139
+ * Raised when a file is opened. Mobile only.
140
+ *
141
+ * @mobileOnly
142
+ */
143
+ get opened(): Event<OpenFileArgs>;
144
+ /**
145
+ * Raised when a file download starts or resumes. Mobile only.
146
+ *
147
+ * @mobileOnly
148
+ */
149
+ get downloadStarted(): Event<FileDownloadStartedEventArgs>;
150
+ /**
151
+ * Raised when a file download ends. Mobile only.
152
+ *
153
+ * @mobileOnly
154
+ */
155
+ get downloadEnded(): Event<FileDownloadEndedEventArgs>;
156
+ }
@@ -1 +1 @@
1
- import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class FileOperations extends r{constructor(){super(...arguments),this._prefix="file"}get pickFile(){return this._get("pick-file")}}export class FileCommands extends e{constructor(){super(...arguments),this._prefix="file"}get openFile(){return this._get("open-file")}}export class FileEvents extends t{constructor(){super(...arguments),this._prefix="file"}get opened(){return this._get("opened")}get downloadStarted(){return this._get("download-started")}get downloadEnded(){return this._get("download-ended")}}
1
+ import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class FileOperations extends r{_prefix="file";get pickFile(){return this._get("pick-file")}}export class FileCommands extends e{_prefix="file";get openFile(){return this._get("open-file")}}export class FileEvents extends t{_prefix="file";get opened(){return this._get("opened")}get downloadStarted(){return this._get("download-started")}get downloadEnded(){return this._get("download-ended")}}
@@ -1,73 +1,73 @@
1
- import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
2
- import type { Command } from "../Command.js";
3
- import { CommandRegistry } from "../CommandRegistry.js";
4
- import type { Operation } from "../Operation.js";
5
- import { OperationRegistry } from "../OperationRegistry.js";
6
- import type { LayersLike, ModelRef } from "../common.js";
7
- /**
8
- * A filter that can be displayed in the filter builder.
9
- */
10
- export interface Filter {
11
- /**
12
- * The feature source to filter. One of `source` or `layers` is required.
13
- */
14
- source?: FeatureSource;
15
- /**
16
- * Alias of `source`, to facilitate command chaining. If multiple layers are
17
- * present, only the first will be used as the source. One of `source` or
18
- * `layers` is required.
19
- */
20
- layers?: LayersLike;
21
- /**
22
- * The where clause to filter by.
23
- */
24
- where?: string;
25
- }
26
- /**
27
- * Base arguments for commands/operations that target filter builder components.
28
- */
29
- export interface FilterBuilderArgsBase {
30
- /**
31
- * The filter builder component that will be targeted. If not specified, all
32
- * active filter builder components in the layout will be targeted.
33
- */
34
- filterBuilder?: ModelRef;
35
- }
36
- /**
37
- * Arguments for the "filter-builder.set-filter" command.
38
- */
39
- export interface SetFilterArgs extends FilterBuilderArgsBase, Filter {
40
- }
41
- export declare class FilterBuilderCommands extends CommandRegistry {
42
- protected readonly _prefix = "filter-builder";
43
- /**
44
- * Sets the current filter criteria in the filter builder and also activates
45
- * the component. Web only.
46
- *
47
- * @webOnly
48
- */
49
- get displayFilter(): Command<SetFilterArgs>;
50
- /**
51
- * Sets the current filter criteria in the filter builder. Web only.
52
- *
53
- * @webOnly
54
- */
55
- get setFilter(): Command<SetFilterArgs>;
56
- }
57
- /**
58
- * Arguments for the "filter-builder.get-filter" operation.
59
- */
60
- export interface GetFilterArgs extends Required<FilterBuilderArgsBase> {
61
- }
62
- export declare class FilterBuilderOperations extends OperationRegistry {
63
- protected readonly _prefix = "filter-builder";
64
- /**
65
- * Gets the currently visible filter from the specified filter builder
66
- * component. Note that this filter may not have yet been applied to the
67
- * layer, so it might differ from the layer's definition expression. Web
68
- * only.
69
- *
70
- * @webOnly
71
- */
72
- get getFilter(): Operation<GetFilterArgs, Filter | undefined>;
73
- }
1
+ import type { FeatureSource } from "@vertigis/arcgis-extensions/data/FeatureSource.js";
2
+ import type { Command } from "../Command.js";
3
+ import { CommandRegistry } from "../CommandRegistry.js";
4
+ import type { Operation } from "../Operation.js";
5
+ import { OperationRegistry } from "../OperationRegistry.js";
6
+ import type { LayersLike, ModelRef } from "../common.js";
7
+ /**
8
+ * A filter that can be displayed in the filter builder.
9
+ */
10
+ export interface Filter {
11
+ /**
12
+ * The feature source to filter. One of `source` or `layers` is required.
13
+ */
14
+ source?: FeatureSource;
15
+ /**
16
+ * Alias of `source`, to facilitate command chaining. If multiple layers are
17
+ * present, only the first will be used as the source. One of `source` or
18
+ * `layers` is required.
19
+ */
20
+ layers?: LayersLike;
21
+ /**
22
+ * The where clause to filter by.
23
+ */
24
+ where?: string;
25
+ }
26
+ /**
27
+ * Base arguments for commands/operations that target filter builder components.
28
+ */
29
+ export interface FilterBuilderArgsBase {
30
+ /**
31
+ * The filter builder component that will be targeted. If not specified, all
32
+ * active filter builder components in the layout will be targeted.
33
+ */
34
+ filterBuilder?: ModelRef;
35
+ }
36
+ /**
37
+ * Arguments for the "filter-builder.set-filter" command.
38
+ */
39
+ export interface SetFilterArgs extends FilterBuilderArgsBase, Filter {
40
+ }
41
+ export declare class FilterBuilderCommands extends CommandRegistry {
42
+ protected readonly _prefix = "filter-builder";
43
+ /**
44
+ * Sets the current filter criteria in the filter builder and also activates
45
+ * the component. Web only.
46
+ *
47
+ * @webOnly
48
+ */
49
+ get displayFilter(): Command<SetFilterArgs>;
50
+ /**
51
+ * Sets the current filter criteria in the filter builder. Web only.
52
+ *
53
+ * @webOnly
54
+ */
55
+ get setFilter(): Command<SetFilterArgs>;
56
+ }
57
+ /**
58
+ * Arguments for the "filter-builder.get-filter" operation.
59
+ */
60
+ export interface GetFilterArgs extends Required<FilterBuilderArgsBase> {
61
+ }
62
+ export declare class FilterBuilderOperations extends OperationRegistry {
63
+ protected readonly _prefix = "filter-builder";
64
+ /**
65
+ * Gets the currently visible filter from the specified filter builder
66
+ * component. Note that this filter may not have yet been applied to the
67
+ * layer, so it might differ from the layer's definition expression. Web
68
+ * only.
69
+ *
70
+ * @webOnly
71
+ */
72
+ get getFilter(): Operation<GetFilterArgs, Filter | undefined>;
73
+ }
@@ -1 +1 @@
1
- import{CommandRegistry as t}from"../CommandRegistry.js";import{OperationRegistry as e}from"../OperationRegistry.js";export class FilterBuilderCommands extends t{constructor(){super(...arguments),this._prefix="filter-builder"}get displayFilter(){return this._get("display-filter")}get setFilter(){return this._get("set-filter")}}export class FilterBuilderOperations extends e{constructor(){super(...arguments),this._prefix="filter-builder"}get getFilter(){return this._get("get-filter")}}
1
+ import{CommandRegistry as e}from"../CommandRegistry.js";import{OperationRegistry as t}from"../OperationRegistry.js";export class FilterBuilderCommands extends e{_prefix="filter-builder";get displayFilter(){return this._get("display-filter")}get setFilter(){return this._get("set-filter")}}export class FilterBuilderOperations extends t{_prefix="filter-builder";get getFilter(){return this._get("get-filter")}}
@@ -1,87 +1,87 @@
1
- import type Geometry from "@arcgis/core/geometry/Geometry";
2
- import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
3
- import type { CountResult } from "@vertigis/arcgis-extensions/tasks/CountResult.js";
4
- import type { AddressLike, GeocodeOptions } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
5
- import type { Operation } from "../Operation.js";
6
- import { OperationRegistry } from "../OperationRegistry.js";
7
- import type { Features } from "../common.js";
8
- /**
9
- * Arguments for the "geocode.geocode" and "geocode.count" operations.
10
- */
11
- export interface GeocodeArgs {
12
- /**
13
- * The address to look up.
14
- */
15
- address: AddressLike;
16
- /**
17
- * Options that affect geocode results.
18
- */
19
- options: GeocodeOptions;
20
- }
21
- /**
22
- * Arguments for the "geocode.batch-geocode" operation.
23
- */
24
- export interface BatchGeocodeArgs {
25
- /**
26
- * The addresses to look up.
27
- */
28
- addresses: AddressLike[];
29
- /**
30
- * Options that affect geocode results.
31
- */
32
- options: GeocodeOptions;
33
- }
34
- /**
35
- * Arguments for the "geocode.suggest" operation.
36
- */
37
- export interface SuggestArgs {
38
- /**
39
- * The search text entered by the user.
40
- */
41
- searchText: string;
42
- /**
43
- * Options that affect geocode results.
44
- */
45
- options: GeocodeOptions;
46
- }
47
- /**
48
- * Arguments for the "geocode.reverse-geocode" operation.
49
- */
50
- export interface ReverseGeocodeArgs {
51
- /**
52
- * The location to look up.
53
- */
54
- geometry: Geometry;
55
- /**
56
- * Options that affect geocode results.
57
- */
58
- options: GeocodeOptions;
59
- }
60
- export declare class GeocodeOperations extends OperationRegistry {
61
- protected readonly _prefix = "geocode";
62
- /**
63
- * Finds one or more locations corresponding to an address.
64
- */
65
- get geocode(): Operation<GeocodeArgs, Features>;
66
- /**
67
- * Finds locations corresponding to multiple addresses. The geocoder must
68
- * have the supportsBatchGeocoding capability. Web only.
69
- *
70
- * @webOnly
71
- */
72
- get batchGeocode(): Operation<BatchGeocodeArgs, Features>;
73
- /**
74
- * Counts the number of locations corresponding to an address.
75
- */
76
- get count(): Operation<GeocodeArgs, CountResult>;
77
- /**
78
- * Suggests matching addresses to search for based on some input text. The
79
- * geocoder must have the supportsSuggest capability.
80
- */
81
- get suggest(): Operation<SuggestArgs, string[]>;
82
- /**
83
- * Finds the address at a particular location. The geocoder must have the
84
- * supportsReverseGeocoding capability.
85
- */
86
- get reverseGeocode(): Operation<ReverseGeocodeArgs, Feature>;
87
- }
1
+ import type Geometry from "@arcgis/core/geometry/Geometry";
2
+ import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
3
+ import type { CountResult } from "@vertigis/arcgis-extensions/tasks/CountResult.js";
4
+ import type { AddressLike, GeocodeOptions } from "@vertigis/arcgis-extensions/tasks/geocoding/Geocoder";
5
+ import type { Operation } from "../Operation.js";
6
+ import { OperationRegistry } from "../OperationRegistry.js";
7
+ import type { Features } from "../common.js";
8
+ /**
9
+ * Arguments for the "geocode.geocode" and "geocode.count" operations.
10
+ */
11
+ export interface GeocodeArgs {
12
+ /**
13
+ * The address to look up.
14
+ */
15
+ address: AddressLike;
16
+ /**
17
+ * Options that affect geocode results.
18
+ */
19
+ options: GeocodeOptions;
20
+ }
21
+ /**
22
+ * Arguments for the "geocode.batch-geocode" operation.
23
+ */
24
+ export interface BatchGeocodeArgs {
25
+ /**
26
+ * The addresses to look up.
27
+ */
28
+ addresses: AddressLike[];
29
+ /**
30
+ * Options that affect geocode results.
31
+ */
32
+ options: GeocodeOptions;
33
+ }
34
+ /**
35
+ * Arguments for the "geocode.suggest" operation.
36
+ */
37
+ export interface SuggestArgs {
38
+ /**
39
+ * The search text entered by the user.
40
+ */
41
+ searchText: string;
42
+ /**
43
+ * Options that affect geocode results.
44
+ */
45
+ options: GeocodeOptions;
46
+ }
47
+ /**
48
+ * Arguments for the "geocode.reverse-geocode" operation.
49
+ */
50
+ export interface ReverseGeocodeArgs {
51
+ /**
52
+ * The location to look up.
53
+ */
54
+ geometry: Geometry;
55
+ /**
56
+ * Options that affect geocode results.
57
+ */
58
+ options: GeocodeOptions;
59
+ }
60
+ export declare class GeocodeOperations extends OperationRegistry {
61
+ protected readonly _prefix = "geocode";
62
+ /**
63
+ * Finds one or more locations corresponding to an address.
64
+ */
65
+ get geocode(): Operation<GeocodeArgs, Features>;
66
+ /**
67
+ * Finds locations corresponding to multiple addresses. The geocoder must
68
+ * have the supportsBatchGeocoding capability. Web only.
69
+ *
70
+ * @webOnly
71
+ */
72
+ get batchGeocode(): Operation<BatchGeocodeArgs, Features>;
73
+ /**
74
+ * Counts the number of locations corresponding to an address.
75
+ */
76
+ get count(): Operation<GeocodeArgs, CountResult>;
77
+ /**
78
+ * Suggests matching addresses to search for based on some input text. The
79
+ * geocoder must have the supportsSuggest capability.
80
+ */
81
+ get suggest(): Operation<SuggestArgs, string[]>;
82
+ /**
83
+ * Finds the address at a particular location. The geocoder must have the
84
+ * supportsReverseGeocoding capability.
85
+ */
86
+ get reverseGeocode(): Operation<ReverseGeocodeArgs, Feature>;
87
+ }
@@ -1 +1 @@
1
- import{OperationRegistry as e}from"../OperationRegistry.js";export class GeocodeOperations extends e{constructor(){super(...arguments),this._prefix="geocode"}get geocode(){return this._get("geocode")}get batchGeocode(){return this._get("batch-geocode")}get count(){return this._get("count")}get suggest(){return this._get("suggest")}get reverseGeocode(){return this._get("reverse-geocode")}}
1
+ import{OperationRegistry as e}from"../OperationRegistry.js";export class GeocodeOperations extends e{_prefix="geocode";get geocode(){return this._get("geocode")}get batchGeocode(){return this._get("batch-geocode")}get count(){return this._get("count")}get suggest(){return this._get("suggest")}get reverseGeocode(){return this._get("reverse-geocode")}}