@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.
- package/analytics/AnalyticsContext.d.ts +29 -29
- package/analytics/AnalyticsContext.js +1 -1
- package/analytics/CommonAction.d.ts +90 -90
- package/analytics/CommonAction.js +1 -1
- package/analytics/MobileAction.d.ts +113 -113
- package/analytics/MobileAction.js +1 -1
- package/analytics/WebAction.d.ts +102 -102
- package/analytics/WebAction.js +1 -1
- package/app-config/AppConfig.d.ts +55 -55
- package/app-config/ItemConfig.d.ts +18 -18
- package/app-config/common/AnalyticsModelProperties.d.ts +10 -10
- package/app-config/common/ApplicationModelProperties.d.ts +15 -15
- package/app-config/common/BasemapPickerModelProperties.d.ts +6 -6
- package/app-config/common/BookmarksModelProperties.d.ts +17 -17
- package/app-config/common/BrandingColors.d.ts +102 -102
- package/app-config/common/BrandingModelProperties.d.ts +23 -23
- package/app-config/common/BrandingThemeProperties.d.ts +35 -35
- package/app-config/common/CompassModelProperties.d.ts +6 -6
- package/app-config/common/ComponentModelProperties.d.ts +14 -14
- package/app-config/common/CoordinateFormat.d.ts +4 -4
- package/app-config/common/CoordinateModelProperties.d.ts +43 -43
- package/app-config/common/DialogModelProperties.d.ts +6 -6
- package/app-config/common/EventListenerModelProperties.d.ts +44 -44
- package/app-config/common/ExpandModelProperties.d.ts +6 -6
- package/app-config/common/FeatureDetailsModelProperties.d.ts +27 -27
- package/app-config/common/GeolocationModelProperties.d.ts +6 -6
- package/app-config/common/HighlightModelProperties.d.ts +68 -68
- package/app-config/common/ImageModelProperties.d.ts +14 -14
- package/app-config/common/ItemRef.d.ts +4 -4
- package/app-config/common/LayerListModelProperties.d.ts +6 -6
- package/app-config/common/LayerPresetsModelProperties.d.ts +14 -14
- package/app-config/common/LayoutProperties.d.ts +33 -33
- package/app-config/common/LegendModelProperties.d.ts +6 -6
- package/app-config/common/LicensingModelProperties.d.ts +10 -10
- package/app-config/common/MapCoordinatesModelProperties.d.ts +6 -6
- package/app-config/common/MapModelProperties.d.ts +7 -7
- package/app-config/common/MenuModelProperties.d.ts +13 -13
- package/app-config/common/ModelProperties.d.ts +6 -6
- package/app-config/common/PanelModelProperties.d.ts +6 -6
- package/app-config/common/RegionModelProperties.d.ts +25 -25
- package/app-config/common/ResultsModelProperties.d.ts +13 -13
- package/app-config/common/ScalebarModelProperties.d.ts +6 -6
- package/app-config/common/SearchModelProperties.d.ts +26 -26
- package/app-config/common/ServiceModelProperties.d.ts +6 -6
- package/app-config/common/SplitModelProperties.d.ts +6 -6
- package/app-config/common/StackModelProperties.d.ts +6 -6
- package/app-config/common/TextModelProperties.d.ts +10 -10
- package/app-config/common/TranslatableText.d.ts +35 -35
- package/app-config/common/UserModelProperties.d.ts +6 -6
- package/app-config/common/WorkflowEventsProperties.d.ts +11 -11
- package/app-config/common/WorkflowModelProperties.d.ts +44 -44
- package/app-config/common/ZoomModelProperties.d.ts +6 -6
- package/app-config/common/colors.d.ts +6 -6
- package/app-config/index.d.ts +2 -2
- package/app-config/mobile/AddFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/AddRelatedFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/BasemapModelProperties.d.ts +11 -11
- package/app-config/mobile/CoordinateModelProperties.d.ts +10 -10
- package/app-config/mobile/FeatureDetailsModelProperties.d.ts +26 -26
- package/app-config/mobile/GeometryToolbarModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssDeviceSelectionModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssDeviceSettingsModelProperties.d.ts +6 -6
- package/app-config/mobile/GnssMetadataModelProperties.d.ts +6 -6
- package/app-config/mobile/MapModelProperties.d.ts +52 -52
- package/app-config/mobile/OfflineModelProperties.d.ts +48 -48
- package/app-config/mobile/PortalExtensionSettingsProperties.d.ts +27 -27
- package/app-config/mobile/ScrollModelProperties.d.ts +6 -6
- package/app-config/mobile/SearchModelProperties.d.ts +14 -14
- package/app-config/mobile/SelectLayerSettingsModelProperties.d.ts +11 -11
- package/app-config/mobile/TaskbarModelProperties.d.ts +6 -6
- package/app-config/mobile/UpdateFeatureModelProperties.d.ts +6 -6
- package/app-config/mobile/VertigisMobileModelProperties.d.ts +67 -67
- package/app-config/schema/common-app-config.schema.json +1 -1
- package/app-config/schema/web-app-config.schema.json +1 -1
- package/app-config/web/AddressModelProperties.d.ts +6 -6
- package/app-config/web/BasemapModelProperties.d.ts +10 -10
- package/app-config/web/BasemapPickerModelProperties.d.ts +7 -7
- package/app-config/web/BookmarksModelProperties.d.ts +7 -7
- package/app-config/web/BrandingModelProperties.d.ts +14 -14
- package/app-config/web/ChartModelProperties.d.ts +58 -58
- package/app-config/web/CompassModelProperties.d.ts +7 -7
- package/app-config/web/ComponentModelProperties.d.ts +12 -12
- package/app-config/web/CoordinateModelProperties.d.ts +50 -50
- package/app-config/web/DataLinkSourceProperties.d.ts +15 -15
- package/app-config/web/DialogModelProperties.d.ts +7 -7
- package/app-config/web/DrawModelProperties.d.ts +94 -94
- package/app-config/web/FeatureDetailsModelProperties.d.ts +19 -19
- package/app-config/web/FeatureInfoModelProperties.d.ts +38 -38
- package/app-config/web/FeatureListProperties.d.ts +12 -12
- package/app-config/web/FeatureSetProperties.d.ts +16 -16
- package/app-config/web/FeatureSummaryModelProperties.d.ts +27 -27
- package/app-config/web/GeolocationModelProperties.d.ts +7 -7
- package/app-config/web/GeometryModelProperties.d.ts +27 -27
- package/app-config/web/HasVisibilityFilters.d.ts +36 -36
- package/app-config/web/ImageModelProperties.d.ts +7 -7
- package/app-config/web/KpiCardModelProperties.d.ts +146 -146
- package/app-config/web/LayerListModelProperties.d.ts +18 -18
- package/app-config/web/LayerPresetsModelProperties.d.ts +7 -7
- package/app-config/web/LegendModelProperties.d.ts +7 -7
- package/app-config/web/Map3dToggleModelProperties.d.ts +6 -6
- package/app-config/web/MapCoordinatesModelProperties.d.ts +50 -50
- package/app-config/web/MapModelProperties.d.ts +93 -87
- package/app-config/web/MeasurementModelProperties.d.ts +36 -36
- package/app-config/web/MenuItemModelProperties.d.ts +7 -7
- package/app-config/web/MenuModelProperties.d.ts +13 -13
- package/app-config/web/ModelProperties.d.ts +7 -7
- package/app-config/web/PanelModelProperties.d.ts +7 -7
- package/app-config/web/PortalModelProperties.d.ts +11 -11
- package/app-config/web/PrintFormModelProperties.d.ts +42 -42
- package/app-config/web/PrintModelProperties.d.ts +11 -11
- package/app-config/web/ProjectModelProperties.d.ts +12 -12
- package/app-config/web/QueryBuilderModelProperties.d.ts +22 -22
- package/app-config/web/ReportModelProperties.d.ts +15 -15
- package/app-config/web/ResultsModelProperties.d.ts +101 -101
- package/app-config/web/ResultsServiceModelProperties.d.ts +48 -48
- package/app-config/web/ScaleInputModelProperties.d.ts +6 -6
- package/app-config/web/ScalebarModelProperties.d.ts +22 -22
- package/app-config/web/SearchModelProperties.d.ts +22 -22
- package/app-config/web/SearchServiceProperties.d.ts +25 -25
- package/app-config/web/SharedProjectsModelProperties.d.ts +53 -53
- package/app-config/web/SharedStorageModelProperties.d.ts +30 -30
- package/app-config/web/SnappingProperties.d.ts +101 -101
- package/app-config/web/SplitModelProperties.d.ts +7 -7
- package/app-config/web/StackModelProperties.d.ts +7 -7
- package/app-config/web/TabsModelProperties.d.ts +6 -6
- package/app-config/web/TextModelProperties.d.ts +7 -7
- package/app-config/web/TopologyProperties.d.ts +67 -0
- package/app-config/web/TopologyProperties.js +1 -0
- package/app-config/web/UserModelProperties.d.ts +12 -12
- package/app-config/web/UserPreferencesModelProperties.d.ts +10 -10
- package/app-config/web/VertigisWebModelProperties.d.ts +74 -74
- package/app-config/web/WorkflowModelProperties.d.ts +13 -13
- package/app-config/web/ZoomModelProperties.d.ts +7 -7
- package/messaging/Command.d.ts +76 -76
- package/messaging/CommandRegistry.d.ts +25 -25
- package/messaging/CommandRegistry.js +1 -1
- package/messaging/DotNetTypes.d.ts +4 -4
- package/messaging/Event.d.ts +26 -26
- package/messaging/EventRegistry.d.ts +25 -25
- package/messaging/EventRegistry.js +1 -1
- package/messaging/Message.d.ts +50 -50
- package/messaging/MessageBus.d.ts +54 -54
- package/messaging/Operation.d.ts +77 -77
- package/messaging/OperationRegistry.d.ts +26 -26
- package/messaging/OperationRegistry.js +1 -1
- package/messaging/common.d.ts +354 -354
- package/messaging/mobile.d.ts +6 -6
- package/messaging/registry/Commands.d.ts +78 -78
- package/messaging/registry/Commands.js +1 -1
- package/messaging/registry/Events.d.ts +62 -62
- package/messaging/registry/Events.js +1 -1
- package/messaging/registry/Operations.d.ts +69 -69
- package/messaging/registry/Operations.js +1 -1
- package/messaging/registry/app-config.d.ts +12 -12
- package/messaging/registry/app-config.js +1 -1
- package/messaging/registry/app.d.ts +264 -264
- package/messaging/registry/app.js +1 -1
- package/messaging/registry/arcade.d.ts +115 -115
- package/messaging/registry/arcade.js +1 -1
- package/messaging/registry/auth.d.ts +151 -151
- package/messaging/registry/auth.js +1 -1
- package/messaging/registry/basemap.d.ts +74 -74
- package/messaging/registry/basemap.js +1 -1
- package/messaging/registry/bookmark.d.ts +42 -42
- package/messaging/registry/bookmark.js +1 -1
- package/messaging/registry/charts.d.ts +81 -81
- package/messaging/registry/charts.js +1 -1
- package/messaging/registry/debugConsole.d.ts +26 -26
- package/messaging/registry/debugConsole.js +1 -1
- package/messaging/registry/device.d.ts +28 -28
- package/messaging/registry/device.js +1 -1
- package/messaging/registry/display.d.ts +17 -17
- package/messaging/registry/display.js +1 -1
- package/messaging/registry/drawing.d.ts +149 -149
- package/messaging/registry/drawing.js +1 -1
- package/messaging/registry/edit.d.ts +371 -371
- package/messaging/registry/edit.js +1 -1
- package/messaging/registry/file.d.ts +156 -156
- package/messaging/registry/file.js +1 -1
- package/messaging/registry/filter-builder.d.ts +73 -73
- package/messaging/registry/filter-builder.js +1 -1
- package/messaging/registry/geocode.d.ts +87 -87
- package/messaging/registry/geocode.js +1 -1
- package/messaging/registry/geolocation.d.ts +499 -499
- package/messaging/registry/geolocation.js +1 -1
- package/messaging/registry/geometry-toolbar.d.ts +29 -29
- package/messaging/registry/geometry-toolbar.js +1 -1
- package/messaging/registry/geometry.d.ts +278 -278
- package/messaging/registry/geometry.js +1 -1
- package/messaging/registry/highlights.d.ts +86 -86
- package/messaging/registry/highlights.js +1 -1
- package/messaging/registry/input.d.ts +22 -22
- package/messaging/registry/input.js +1 -1
- package/messaging/registry/iwtm.d.ts +11 -11
- package/messaging/registry/iwtm.js +1 -1
- package/messaging/registry/kpi.d.ts +98 -98
- package/messaging/registry/kpi.js +1 -1
- package/messaging/registry/layer-comparison.d.ts +104 -104
- package/messaging/registry/layer-comparison.js +1 -1
- package/messaging/registry/layer-presets.d.ts +49 -49
- package/messaging/registry/layer-presets.js +1 -1
- package/messaging/registry/layers.d.ts +196 -196
- package/messaging/registry/layers.js +1 -1
- package/messaging/registry/layout.d.ts +49 -49
- package/messaging/registry/layout.js +1 -1
- package/messaging/registry/licensing.d.ts +38 -38
- package/messaging/registry/licensing.js +1 -1
- package/messaging/registry/location-marker.d.ts +171 -171
- package/messaging/registry/location-marker.js +1 -1
- package/messaging/registry/logViewer.d.ts +17 -17
- package/messaging/registry/logViewer.js +1 -1
- package/messaging/registry/map.d.ts +1275 -1275
- package/messaging/registry/map.js +1 -1
- package/messaging/registry/measurement.d.ts +168 -168
- package/messaging/registry/measurement.js +1 -1
- package/messaging/registry/messaging.d.ts +23 -23
- package/messaging/registry/messaging.js +1 -1
- package/messaging/registry/network.d.ts +46 -46
- package/messaging/registry/network.js +1 -1
- package/messaging/registry/offline.d.ts +508 -507
- package/messaging/registry/offline.js +1 -1
- package/messaging/registry/panel.d.ts +115 -115
- package/messaging/registry/panel.js +1 -1
- package/messaging/registry/photos.d.ts +47 -47
- package/messaging/registry/photos.js +1 -1
- package/messaging/registry/portal.d.ts +94 -94
- package/messaging/registry/portal.js +1 -1
- package/messaging/registry/printing.d.ts +166 -166
- package/messaging/registry/printing.js +1 -1
- package/messaging/registry/project.d.ts +144 -144
- package/messaging/registry/project.js +1 -1
- package/messaging/registry/query-builder.d.ts +83 -83
- package/messaging/registry/query-builder.js +1 -1
- package/messaging/registry/region.d.ts +23 -23
- package/messaging/registry/region.js +1 -1
- package/messaging/registry/reports.d.ts +135 -135
- package/messaging/registry/reports.js +1 -1
- package/messaging/registry/results.d.ts +671 -671
- package/messaging/registry/results.js +1 -1
- package/messaging/registry/search.d.ts +74 -74
- package/messaging/registry/search.js +1 -1
- package/messaging/registry/settings.d.ts +38 -38
- package/messaging/registry/settings.js +1 -1
- package/messaging/registry/shortcut.d.ts +41 -41
- package/messaging/registry/shortcut.js +1 -1
- package/messaging/registry/sketching.d.ts +1019 -960
- package/messaging/registry/sketching.js +1 -1
- package/messaging/registry/studioAnalytics.d.ts +25 -25
- package/messaging/registry/studioAnalytics.js +1 -1
- package/messaging/registry/system.d.ts +277 -277
- package/messaging/registry/system.js +1 -1
- package/messaging/registry/tasks.d.ts +323 -323
- package/messaging/registry/tasks.js +1 -1
- package/messaging/registry/ui.d.ts +518 -518
- package/messaging/registry/ui.js +1 -1
- package/messaging/registry/viewer.d.ts +145 -145
- package/messaging/registry/viewer.js +1 -1
- package/messaging/registry/workflow.d.ts +170 -170
- package/messaging/registry/workflow.js +1 -1
- package/messaging/schema/common-action.schema.json +6437 -12158
- package/messaging/schema/common-event.schema.json +107 -803
- package/messaging/schema/mobile-action.schema.json +7719 -16138
- package/messaging/schema/mobile-event.schema.json +181 -2422
- package/messaging/schema/web-action.schema.json +8415 -23272
- package/messaging/schema/web-event.schema.json +183 -1937
- package/package.json +20 -20
- package/version.d.ts +4 -4
- package/version.js +4 -4
|
@@ -1,960 +1,1019 @@
|
|
|
1
|
-
import type Graphic from "@arcgis/core/Graphic";
|
|
2
|
-
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
3
|
-
import type Point from "@arcgis/core/geometry/Point";
|
|
4
|
-
import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
|
|
5
|
-
import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
|
|
6
|
-
import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
|
|
7
|
-
import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D";
|
|
8
|
-
import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
|
|
9
|
-
import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
|
|
10
|
-
import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
|
|
11
|
-
import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
|
|
12
|
-
import type Symbol from "@arcgis/core/symbols/Symbol";
|
|
13
|
-
import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
|
|
14
|
-
import type {
|
|
15
|
-
import type {
|
|
16
|
-
import type {
|
|
17
|
-
import type {
|
|
18
|
-
import {
|
|
19
|
-
import type {
|
|
20
|
-
import {
|
|
21
|
-
import type {
|
|
22
|
-
import {
|
|
23
|
-
import type {
|
|
24
|
-
import
|
|
25
|
-
import type {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
* @
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
*
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
* are
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
*
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
*
|
|
159
|
-
* @
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
*
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
*
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
*
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
*
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
*
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
*
|
|
234
|
-
*
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
*
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
*
|
|
302
|
-
*
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
*
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
*
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
*
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
*
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
*/
|
|
407
|
-
|
|
408
|
-
}
|
|
409
|
-
/**
|
|
410
|
-
* Arguments for the "sketching.
|
|
411
|
-
*/
|
|
412
|
-
export interface
|
|
413
|
-
/**
|
|
414
|
-
* The
|
|
415
|
-
*/
|
|
416
|
-
|
|
417
|
-
/**
|
|
418
|
-
* The
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
*
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
*
|
|
457
|
-
*/
|
|
458
|
-
|
|
459
|
-
/**
|
|
460
|
-
* The
|
|
461
|
-
*
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
*
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
*
|
|
480
|
-
*/
|
|
481
|
-
export interface
|
|
482
|
-
/**
|
|
483
|
-
* The
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
*
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
*
|
|
496
|
-
*
|
|
497
|
-
*/
|
|
498
|
-
|
|
499
|
-
/**
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
/**
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
/**
|
|
544
|
-
*
|
|
545
|
-
*/
|
|
546
|
-
export interface
|
|
547
|
-
/**
|
|
548
|
-
*
|
|
549
|
-
*/
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
/**
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
/**
|
|
587
|
-
* The
|
|
588
|
-
*/
|
|
589
|
-
|
|
590
|
-
/**
|
|
591
|
-
*
|
|
592
|
-
*/
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
*
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
*
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
*
|
|
664
|
-
*
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
*
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
*
|
|
696
|
-
*
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
*
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
*
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
*
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
*
|
|
730
|
-
*
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
*
|
|
743
|
-
*
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
*
|
|
758
|
-
*
|
|
759
|
-
*
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
*
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
*
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
*
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
*
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
*
|
|
807
|
-
*/
|
|
808
|
-
get
|
|
809
|
-
/**
|
|
810
|
-
*
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
*
|
|
815
|
-
*/
|
|
816
|
-
get
|
|
817
|
-
/**
|
|
818
|
-
*
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
*
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
*
|
|
840
|
-
*
|
|
841
|
-
* @
|
|
842
|
-
*/
|
|
843
|
-
get
|
|
844
|
-
/**
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
* @
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
*
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
*
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
*
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
*
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
|
|
896
|
-
|
|
897
|
-
*
|
|
898
|
-
*
|
|
899
|
-
*
|
|
900
|
-
|
|
901
|
-
|
|
902
|
-
|
|
903
|
-
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
*
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
*
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
*
|
|
928
|
-
*
|
|
929
|
-
*/
|
|
930
|
-
get
|
|
931
|
-
/**
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
*
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
*
|
|
951
|
-
*
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
*
|
|
957
|
-
*
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
1
|
+
import type Graphic from "@arcgis/core/Graphic";
|
|
2
|
+
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
3
|
+
import type Point from "@arcgis/core/geometry/Point";
|
|
4
|
+
import type LineSymbol3D from "@arcgis/core/symbols/LineSymbol3D";
|
|
5
|
+
import type PictureFillSymbol from "@arcgis/core/symbols/PictureFillSymbol";
|
|
6
|
+
import type PictureMarkerSymbol from "@arcgis/core/symbols/PictureMarkerSymbol";
|
|
7
|
+
import type PointSymbol3D from "@arcgis/core/symbols/PointSymbol3D";
|
|
8
|
+
import type PolygonSymbol3D from "@arcgis/core/symbols/PolygonSymbol3D";
|
|
9
|
+
import type SimpleFillSymbol from "@arcgis/core/symbols/SimpleFillSymbol";
|
|
10
|
+
import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol";
|
|
11
|
+
import type SimpleMarkerSymbol from "@arcgis/core/symbols/SimpleMarkerSymbol";
|
|
12
|
+
import type Symbol from "@arcgis/core/symbols/Symbol";
|
|
13
|
+
import type TextSymbol from "@arcgis/core/symbols/TextSymbol";
|
|
14
|
+
import type { Feature } from "@vertigis/arcgis-extensions/data/Feature.js";
|
|
15
|
+
import type { LineSymbol3DJson, PictureFillSymbolJson, PictureMarkerSymbolJson, PointSymbol3DJson, PolygonSymbol3DJson, SimpleFillSymbolJson, SimpleLineSymbolJson, SimpleMarkerSymbolJson, SymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
|
|
16
|
+
import type { MapExtension } from "@vertigis/arcgis-extensions/mapping/MapExtension";
|
|
17
|
+
import type { SnappingProperties } from "app-config/web/SnappingProperties.js";
|
|
18
|
+
import type { TopologyProperties } from "app-config/web/TopologyProperties.js";
|
|
19
|
+
import type { Command } from "../Command.js";
|
|
20
|
+
import { CommandRegistry } from "../CommandRegistry.js";
|
|
21
|
+
import type { Event } from "../Event.js";
|
|
22
|
+
import { EventRegistry } from "../EventRegistry.js";
|
|
23
|
+
import type { Operation } from "../Operation.js";
|
|
24
|
+
import { OperationRegistry } from "../OperationRegistry.js";
|
|
25
|
+
import type { FeaturesLike, GeometryLike, GraphicsLike, HasMaps, Maps, MapsLike } from "../common.js";
|
|
26
|
+
import type { EditSymbolResult } from "./drawing.js";
|
|
27
|
+
import type { GeodeticCurveType, LengthUnits, LengthUnitsMobile, ReferenceLine } from "./geometry.js";
|
|
28
|
+
/**
|
|
29
|
+
* A representation of a 2D vector or point.
|
|
30
|
+
*/
|
|
31
|
+
export interface Vector2D {
|
|
32
|
+
/**
|
|
33
|
+
* The x component.
|
|
34
|
+
*/
|
|
35
|
+
x: number;
|
|
36
|
+
/**
|
|
37
|
+
* The y component.
|
|
38
|
+
*/
|
|
39
|
+
y: number;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* A set of symbols that can be used to sketch geometries.
|
|
43
|
+
*/
|
|
44
|
+
export interface SymbolSet {
|
|
45
|
+
/**
|
|
46
|
+
* The symbol used to draw points.
|
|
47
|
+
*/
|
|
48
|
+
pointSymbol?: SimpleMarkerSymbol | SimpleMarkerSymbolJson | PictureMarkerSymbol | PictureMarkerSymbolJson;
|
|
49
|
+
/**
|
|
50
|
+
* The symbol used to draw 3D points.
|
|
51
|
+
*/
|
|
52
|
+
pointSymbol3D?: PointSymbol3D | PointSymbol3DJson;
|
|
53
|
+
/**
|
|
54
|
+
* The symbol used to draw lines.
|
|
55
|
+
*/
|
|
56
|
+
lineSymbol?: SimpleLineSymbol | SimpleLineSymbolJson;
|
|
57
|
+
/**
|
|
58
|
+
* The symbol used to draw 3D lines.
|
|
59
|
+
*/
|
|
60
|
+
lineSymbol3D?: LineSymbol3D | LineSymbol3DJson;
|
|
61
|
+
/**
|
|
62
|
+
* The symbol used to draw polygons.
|
|
63
|
+
*/
|
|
64
|
+
polygonSymbol?: SimpleFillSymbol | SimpleFillSymbolJson | PictureFillSymbol | PictureFillSymbolJson;
|
|
65
|
+
/**
|
|
66
|
+
* The symbol used to draw 3D polygons.
|
|
67
|
+
*/
|
|
68
|
+
polygonSymbol3D?: PolygonSymbol3D | PolygonSymbol3DJson;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* The type of tool used for sketching.
|
|
72
|
+
*/
|
|
73
|
+
export declare enum SketchTool {
|
|
74
|
+
POINT = "point",
|
|
75
|
+
MULTIPOINT = "multipoint",
|
|
76
|
+
/**
|
|
77
|
+
* Not supported in VertiGIS Studio Mobile.
|
|
78
|
+
*/
|
|
79
|
+
LINE = "line",
|
|
80
|
+
POLYLINE = "polyline",
|
|
81
|
+
POLYGON = "polygon",
|
|
82
|
+
EXTENT = "extent",
|
|
83
|
+
/**
|
|
84
|
+
* Not supported in VertiGIS Studio Mobile.
|
|
85
|
+
*/
|
|
86
|
+
SQUARE = "square",
|
|
87
|
+
/**
|
|
88
|
+
* Not supported in VertiGIS Studio Mobile.
|
|
89
|
+
*/
|
|
90
|
+
CIRCLE = "circle"
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Indicates whether a new point should be added before or after the active
|
|
94
|
+
* point in a sketch.
|
|
95
|
+
*/
|
|
96
|
+
export type AddNodeOrder = "add-after-active" | "add-before-active";
|
|
97
|
+
/**
|
|
98
|
+
* Deprecated - use "sketching.move-point" with {@link MovePointArgs}.
|
|
99
|
+
*
|
|
100
|
+
* @deprecated
|
|
101
|
+
*/
|
|
102
|
+
export interface MoveNodeArgs extends HasMaps {
|
|
103
|
+
/**
|
|
104
|
+
* The point to move, which must already exist within the active sketch. If
|
|
105
|
+
* not provided, the active point will be used.
|
|
106
|
+
*/
|
|
107
|
+
node?: Point;
|
|
108
|
+
/**
|
|
109
|
+
* The new position for the point.
|
|
110
|
+
*/
|
|
111
|
+
position: Geometry;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* The arguments for the "sketching.move-point" command.
|
|
115
|
+
*/
|
|
116
|
+
export interface MovePointArgs extends HasMaps {
|
|
117
|
+
/**
|
|
118
|
+
* The point to move, which must already exist within the active sketch. If
|
|
119
|
+
* this property is undefined and no geometry and pointIndex are specified,
|
|
120
|
+
* the active point(s) will be moved.
|
|
121
|
+
*/
|
|
122
|
+
point?: Point;
|
|
123
|
+
/**
|
|
124
|
+
* The geometry where the point exists, if multiple are present in an active
|
|
125
|
+
* editing session. This property is required if pointIndex and/or partIndex
|
|
126
|
+
* are defined.
|
|
127
|
+
*/
|
|
128
|
+
geometry?: Geometry;
|
|
129
|
+
/**
|
|
130
|
+
* The index of the point. If this property is defined, the 'geometry'
|
|
131
|
+
* property must also be defined.
|
|
132
|
+
*/
|
|
133
|
+
pointIndex?: number;
|
|
134
|
+
/**
|
|
135
|
+
* The part of the geometry where the point exists. Required for polyline
|
|
136
|
+
* and polygon geometry types when the geometry and pointIndex properties
|
|
137
|
+
* are defined.
|
|
138
|
+
*/
|
|
139
|
+
partIndex?: number;
|
|
140
|
+
/**
|
|
141
|
+
* The new point that will replace the target point within an active sketch
|
|
142
|
+
* or edit geometry. If this property is defined, the distance property will
|
|
143
|
+
* be ignored.
|
|
144
|
+
*/
|
|
145
|
+
newPoint?: Point;
|
|
146
|
+
/**
|
|
147
|
+
* An amount to move the point(s) on the X and Y axes. If the newPoint
|
|
148
|
+
* property is defined, this property will be ignored.
|
|
149
|
+
*/
|
|
150
|
+
distance?: Vector2D;
|
|
151
|
+
/**
|
|
152
|
+
* The units of the above distance. Optional, will default to the units used
|
|
153
|
+
* by the measurement service associated with the map.
|
|
154
|
+
*/
|
|
155
|
+
units?: LengthUnits;
|
|
156
|
+
}
|
|
157
|
+
/**
|
|
158
|
+
* Deprecated - use "sketching.set-active-points" with
|
|
159
|
+
* {@link SetActivePointsArgs}.
|
|
160
|
+
*
|
|
161
|
+
* @deprecated
|
|
162
|
+
*/
|
|
163
|
+
export interface SwitchActiveNodeArgs extends HasMaps {
|
|
164
|
+
/**
|
|
165
|
+
* The new point that will become the active point of an active sketch.
|
|
166
|
+
*/
|
|
167
|
+
node: Point;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
* The arguments for the "sketching.set-active-points" command.
|
|
171
|
+
*/
|
|
172
|
+
export interface SetActivePointsArgs extends HasMaps {
|
|
173
|
+
/**
|
|
174
|
+
* The new point(s) that will become active in the sketch or editing
|
|
175
|
+
* session. Sketching only supports one active point; if multiple are
|
|
176
|
+
* specified, then only the first will be set as active.
|
|
177
|
+
*/
|
|
178
|
+
points?: Point | Point[];
|
|
179
|
+
/**
|
|
180
|
+
* The geometry where the new active point exists, if multiple are present
|
|
181
|
+
* in an active editing session. This property is required if pointIndex
|
|
182
|
+
* and/or partIndex are defined.
|
|
183
|
+
*/
|
|
184
|
+
geometry?: Geometry;
|
|
185
|
+
/**
|
|
186
|
+
* The index of the new active point. If this property is defined, the
|
|
187
|
+
* geometry property must be defined.
|
|
188
|
+
*/
|
|
189
|
+
pointIndex?: number;
|
|
190
|
+
/**
|
|
191
|
+
* The part of the geometry where the new active point exists. Required for
|
|
192
|
+
* polyline and polygon geometry types when the geometry and pointIndex
|
|
193
|
+
* properties are defined.
|
|
194
|
+
*/
|
|
195
|
+
partIndex?: number;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* Arguments for the "sketching.capture-geometry" operation.
|
|
199
|
+
*/
|
|
200
|
+
export interface CaptureGeometryArgs {
|
|
201
|
+
/**
|
|
202
|
+
* The maps to activate drawing on. By default it will be all maps.
|
|
203
|
+
*/
|
|
204
|
+
maps?: MapsLike;
|
|
205
|
+
/**
|
|
206
|
+
* The geometry/shape to use for sketching. * Multiple sketch tools are only
|
|
207
|
+
* supported by VertiGIS Studio Web. When multiple sketch tools are
|
|
208
|
+
* provided, the sketch will begin with the first one in the list. If
|
|
209
|
+
* "point" is the first of multiple options in the list, click actions will
|
|
210
|
+
* create points while click-and-drag actions will automatically begin the
|
|
211
|
+
* freehand variation of the next included geometry type.
|
|
212
|
+
*/
|
|
213
|
+
geometryType: SketchTool | SketchTool[];
|
|
214
|
+
/**
|
|
215
|
+
* An optional symbol to use. SymbolSets are not supported by VertiGIS
|
|
216
|
+
* Studio Mobile.
|
|
217
|
+
*/
|
|
218
|
+
symbol?: SymbolJson | SymbolSet;
|
|
219
|
+
/**
|
|
220
|
+
* The maximum number of segments permitted for a polyline or polygon
|
|
221
|
+
* sketch. Default is no limit. Mobile only.
|
|
222
|
+
*/
|
|
223
|
+
maxSegments?: number;
|
|
224
|
+
/**
|
|
225
|
+
* The settings to be applied to the sketch. Mobile only.
|
|
226
|
+
*/
|
|
227
|
+
editorSettings?: GeometryEditorSettings;
|
|
228
|
+
/**
|
|
229
|
+
* Disables freehand sketching during the draw session. Web only.
|
|
230
|
+
*/
|
|
231
|
+
disableFreehand?: boolean;
|
|
232
|
+
/**
|
|
233
|
+
* Web only. Additional settings that are specific to sketching plugins,
|
|
234
|
+
* keyed by plugin ID. The only currently supported plugin is "snapping". A
|
|
235
|
+
* boolean value can also be assigned to completely disable, or enable with
|
|
236
|
+
* default settings.
|
|
237
|
+
*/
|
|
238
|
+
pluginSettings?: Record<string, boolean | Record<string, unknown>>;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Result of the "sketching.capture-geometry" operation.
|
|
242
|
+
*/
|
|
243
|
+
export interface CaptureGeometryResult {
|
|
244
|
+
/**
|
|
245
|
+
* The geometry that was captured.
|
|
246
|
+
*/
|
|
247
|
+
geometry: Geometry;
|
|
248
|
+
/**
|
|
249
|
+
* The map that the user sketched the geometry on. Unavailable in VertiGIS
|
|
250
|
+
* Studio Mobile.
|
|
251
|
+
*/
|
|
252
|
+
maps: MapsLike;
|
|
253
|
+
/**
|
|
254
|
+
* The symbol that was used. Unavailable in VertiGIS Studio Web.
|
|
255
|
+
*/
|
|
256
|
+
symbol?: Symbol;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* A generic context for operations that act on geometries.
|
|
260
|
+
*/
|
|
261
|
+
export interface GeometryOperationBase {
|
|
262
|
+
/**
|
|
263
|
+
* The maps to activate editing on. By default it will be all maps.
|
|
264
|
+
*/
|
|
265
|
+
maps?: MapsLike;
|
|
266
|
+
/**
|
|
267
|
+
* The geometries to edit.
|
|
268
|
+
*/
|
|
269
|
+
geometry?: GeometryLike;
|
|
270
|
+
/**
|
|
271
|
+
* The graphics containing geometries to edit. The graphics will pass
|
|
272
|
+
* through and be assigned the altered geometries. Not supported in Mobile.
|
|
273
|
+
*/
|
|
274
|
+
graphics?: GraphicsLike;
|
|
275
|
+
/**
|
|
276
|
+
* The features containing geometries to edit. The features will pass
|
|
277
|
+
* through and be assigned the altered geometries. Not supported in Mobile.
|
|
278
|
+
*/
|
|
279
|
+
features?: FeaturesLike;
|
|
280
|
+
/**
|
|
281
|
+
* Flag all inputs as measured geometries. Geometry operations will show
|
|
282
|
+
* measurements for in progress operations. Not supported in Mobile.
|
|
283
|
+
*/
|
|
284
|
+
isMeasurement?: boolean;
|
|
285
|
+
/**
|
|
286
|
+
* An optional symbol to use while editing.
|
|
287
|
+
*/
|
|
288
|
+
symbol?: SimpleLineSymbol | PictureFillSymbol | PictureMarkerSymbol | SimpleFillSymbol | SimpleMarkerSymbol | TextSymbol | Symbol;
|
|
289
|
+
}
|
|
290
|
+
/**
|
|
291
|
+
* Arguments for the "sketching.edit-geometry" operation.
|
|
292
|
+
*/
|
|
293
|
+
export interface EditGeometryArgs extends GeometryOperationBase {
|
|
294
|
+
/**
|
|
295
|
+
* The options for this edit operation. Not supported in Mobile. Web only.
|
|
296
|
+
*
|
|
297
|
+
* @webOnly
|
|
298
|
+
*/
|
|
299
|
+
options?: EditGeometryOptions;
|
|
300
|
+
/**
|
|
301
|
+
* Web only. Additional settings that are specific to sketching plugins,
|
|
302
|
+
* keyed by plugin ID. The only currently supported plugin is "snapping". A
|
|
303
|
+
* boolean value can also be assigned to completely disable, or enable with
|
|
304
|
+
* default settings.
|
|
305
|
+
*/
|
|
306
|
+
pluginSettings?: Record<string, boolean | Record<string, unknown>>;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* Options for the "sketching.edit-geometry operation.
|
|
310
|
+
*
|
|
311
|
+
* @webOnly
|
|
312
|
+
*/
|
|
313
|
+
export interface EditGeometryOptions {
|
|
314
|
+
/**
|
|
315
|
+
* Whether to allow deletion of the edited geometry. Defaults to false.
|
|
316
|
+
*/
|
|
317
|
+
enableDelete?: boolean;
|
|
318
|
+
/**
|
|
319
|
+
* Whether to allow rotation of the edited geometry. Defaults to true.
|
|
320
|
+
*/
|
|
321
|
+
enableRotation?: boolean;
|
|
322
|
+
/**
|
|
323
|
+
* Whether to allow scaling of the edited geometry. Defaults to true.
|
|
324
|
+
*/
|
|
325
|
+
enableScaling?: boolean;
|
|
326
|
+
/**
|
|
327
|
+
* Whether to allow the user to toggle to the non-default scale mode.
|
|
328
|
+
* Defaults to true.
|
|
329
|
+
*/
|
|
330
|
+
enableScaleModeToggle?: boolean;
|
|
331
|
+
/**
|
|
332
|
+
* Whether to allow the user to add, move, and remove vertices from a
|
|
333
|
+
* geometry. Defaults to true.
|
|
334
|
+
*/
|
|
335
|
+
enableVertexEditing?: boolean;
|
|
336
|
+
/**
|
|
337
|
+
* Setting "free" allows independent scaling on the x and y axis,
|
|
338
|
+
* "preserve-aspect-ratio" constrains scaling to the original aspect ratio.
|
|
339
|
+
* Defaults to "preserve-aspect-ratio".
|
|
340
|
+
*/
|
|
341
|
+
scaleMode?: "free" | "preserve-aspect-ratio";
|
|
342
|
+
/**
|
|
343
|
+
* Whether the resulting geometry is validated before it's returned from the
|
|
344
|
+
* operation. If the geometry is invalid upon completion, an error is
|
|
345
|
+
* thrown. Defaults to true.
|
|
346
|
+
*/
|
|
347
|
+
validateGeometry?: boolean;
|
|
348
|
+
/**
|
|
349
|
+
* Where to anchor the geometry when performing a free scale operation.
|
|
350
|
+
* Defaults to "center".
|
|
351
|
+
*/
|
|
352
|
+
anchor?: "center" | "opposite";
|
|
353
|
+
}
|
|
354
|
+
/**
|
|
355
|
+
* Result of the "sketching.edit-geometry" operation.
|
|
356
|
+
*/
|
|
357
|
+
export interface EditGeometryResult extends GeometryOperationBase {
|
|
358
|
+
/**
|
|
359
|
+
* Any coincident Features that were included in the geometry editing
|
|
360
|
+
* session, if topological editing was enabled. Web only.
|
|
361
|
+
*/
|
|
362
|
+
coincidentFeatures?: Feature[];
|
|
363
|
+
/**
|
|
364
|
+
* Any coincident Graphics that were included in the geometry editing
|
|
365
|
+
* session, if topological editing was enabled. Web only.
|
|
366
|
+
*/
|
|
367
|
+
coincidentGraphics?: CoincidentEditingGraphicResult[];
|
|
368
|
+
}
|
|
369
|
+
/**
|
|
370
|
+
* The result of a Graphic being coincidentally edited as a part of a editing
|
|
371
|
+
* session with topological editing enabled. Web Only.
|
|
372
|
+
*/
|
|
373
|
+
export interface CoincidentEditingGraphicResult {
|
|
374
|
+
/**
|
|
375
|
+
* The coincident graphic that was included in an editing session with
|
|
376
|
+
* topological editing enabled.
|
|
377
|
+
*/
|
|
378
|
+
graphic: Graphic;
|
|
379
|
+
/**
|
|
380
|
+
* A copy of the original geometry of the Graphic, before it was edited.
|
|
381
|
+
*/
|
|
382
|
+
originalGeometry: Geometry;
|
|
383
|
+
}
|
|
384
|
+
/**
|
|
385
|
+
* Arguments for the "sketching.move-geometry" operation.
|
|
386
|
+
*/
|
|
387
|
+
export interface MoveGeometryArgs extends GeometryOperationBase {
|
|
388
|
+
/**
|
|
389
|
+
* An amount to move the geometry on the X and Y axes.
|
|
390
|
+
*/
|
|
391
|
+
distance: Vector2D;
|
|
392
|
+
/**
|
|
393
|
+
* The units of the above distance. Optional, will default to the units used
|
|
394
|
+
* by the measurement service associated with the map.
|
|
395
|
+
*/
|
|
396
|
+
units?: LengthUnits;
|
|
397
|
+
}
|
|
398
|
+
/**
|
|
399
|
+
* Arguments for the "sketching.scale-geometry" operation.
|
|
400
|
+
*/
|
|
401
|
+
export interface ScaleGeometryArgs extends GeometryOperationBase {
|
|
402
|
+
/**
|
|
403
|
+
* The amount to scale the geometry, specified either uniformly or
|
|
404
|
+
* independently on the x and y axis. Point geometries will not be modified
|
|
405
|
+
* by this operation.
|
|
406
|
+
*/
|
|
407
|
+
scale: Vector2D | number;
|
|
408
|
+
}
|
|
409
|
+
/**
|
|
410
|
+
* Arguments for the "sketching.rotate-geometry" operation.
|
|
411
|
+
*/
|
|
412
|
+
export interface RotateGeometryArgs extends GeometryOperationBase {
|
|
413
|
+
/**
|
|
414
|
+
* The number of degrees to rotate the geometry.
|
|
415
|
+
*/
|
|
416
|
+
degrees: number;
|
|
417
|
+
/**
|
|
418
|
+
* The origin around which to rotate the geometry. Defaults to the centroid.
|
|
419
|
+
*/
|
|
420
|
+
origin?: Point;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Arguments for the "sketching.stop" operation.
|
|
424
|
+
*/
|
|
425
|
+
export interface StopGeometryEditArgs {
|
|
426
|
+
/**
|
|
427
|
+
* The maps on which to stop editing geometry.
|
|
428
|
+
*/
|
|
429
|
+
maps: MapsLike;
|
|
430
|
+
/**
|
|
431
|
+
* Whether to validate the geometry before returning it. Defaults to true if
|
|
432
|
+
* not set.
|
|
433
|
+
*/
|
|
434
|
+
validateGeometry?: boolean;
|
|
435
|
+
}
|
|
436
|
+
/**
|
|
437
|
+
* Arguments for the "sketching.add-point" command.
|
|
438
|
+
*/
|
|
439
|
+
export interface AddPointArgs extends HasMaps {
|
|
440
|
+
/**
|
|
441
|
+
* The new point to be added.
|
|
442
|
+
*/
|
|
443
|
+
newPoint: Point;
|
|
444
|
+
/**
|
|
445
|
+
* The geometry to add the point to, if multiple are present in an active
|
|
446
|
+
* editing session. Not supported by Mobile.
|
|
447
|
+
*/
|
|
448
|
+
geometry?: Geometry;
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* Arguments for the "sketching.insert-point" command.
|
|
452
|
+
*/
|
|
453
|
+
export interface InsertPointArgs extends HasMaps {
|
|
454
|
+
/**
|
|
455
|
+
* The index of the part to which the point will be added. If null, the last
|
|
456
|
+
* part will be used.
|
|
457
|
+
*/
|
|
458
|
+
partIndex?: number;
|
|
459
|
+
/**
|
|
460
|
+
* The index at which the point will be added. If null, the point will be
|
|
461
|
+
* added as the last point.
|
|
462
|
+
*/
|
|
463
|
+
pointIndex?: number;
|
|
464
|
+
/**
|
|
465
|
+
* The new point to be added.
|
|
466
|
+
*/
|
|
467
|
+
newPoint: Point;
|
|
468
|
+
/**
|
|
469
|
+
* The geometry to add the point to, if multiple are present in an active
|
|
470
|
+
* editing session. Not supported by Mobile.
|
|
471
|
+
*/
|
|
472
|
+
geometry?: Geometry;
|
|
473
|
+
}
|
|
474
|
+
/**
|
|
475
|
+
* Deprecated - Mobile users should rather use "geometry.add-point"; Web users
|
|
476
|
+
* should use "sketching.add-point" with {@link AddPointArgs} or
|
|
477
|
+
* "sketching.insert-point" with {@link InsertPointArgs} instead.
|
|
478
|
+
*
|
|
479
|
+
* @deprecated
|
|
480
|
+
*/
|
|
481
|
+
export interface AddNodeToGeometryArgs extends HasMaps {
|
|
482
|
+
/**
|
|
483
|
+
* The initial geometry to add the point to. Can be null.
|
|
484
|
+
*/
|
|
485
|
+
geometry: Geometry;
|
|
486
|
+
/**
|
|
487
|
+
* The type of geometry to create if the initial geometry is null. In
|
|
488
|
+
* VertiGIS Studio Mobile, this value must be 'polygon' or 'polyline'. In
|
|
489
|
+
* VertiGIS Studio Web, this value may also be null if the point being added
|
|
490
|
+
* is intended to be added to the active sketch.
|
|
491
|
+
*/
|
|
492
|
+
geometryType: string;
|
|
493
|
+
/**
|
|
494
|
+
* A point geometry to add to the initial geometry. In VertiGIS Studio Web,
|
|
495
|
+
* this value may be null if the intention is to add a point at the position
|
|
496
|
+
* of the active point of an active sketch.
|
|
497
|
+
*/
|
|
498
|
+
node: Geometry;
|
|
499
|
+
/**
|
|
500
|
+
* Indicates whether the new point should be added before or after the
|
|
501
|
+
* active point in the sketch. Not supported by VertiGIS Studio Mobile.
|
|
502
|
+
*/
|
|
503
|
+
nodeOrder?: AddNodeOrder;
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* Arguments for the "sketching.delete" command.
|
|
507
|
+
*/
|
|
508
|
+
export interface DeleteGeometryArgs extends HasMaps {
|
|
509
|
+
/**
|
|
510
|
+
* The point to remove from the geometry. If this property is defined, the
|
|
511
|
+
* 'pointIndex' and 'partIndex' properties are ignored. If no point nor
|
|
512
|
+
* pointIndex/partIndex are specified, any active points will be deleted. If
|
|
513
|
+
* there are no active points, the entire geometry will be deleted.
|
|
514
|
+
*/
|
|
515
|
+
point?: Point;
|
|
516
|
+
/**
|
|
517
|
+
* The geometry to remove a point from. If this property is not specified,
|
|
518
|
+
* any active vertices will be deleted.
|
|
519
|
+
*/
|
|
520
|
+
geometry?: Geometry;
|
|
521
|
+
/**
|
|
522
|
+
* The index of the point that should be removed from the geometry. If this
|
|
523
|
+
* property is defined, the geometry property must also be defined.
|
|
524
|
+
*/
|
|
525
|
+
pointIndex?: number;
|
|
526
|
+
/**
|
|
527
|
+
* The index of the part of the geometry that the point should be removed
|
|
528
|
+
* from. Required for polyline and polygon geometry types when the geometry
|
|
529
|
+
* and pointIndex properties are defined.
|
|
530
|
+
*/
|
|
531
|
+
partIndex?: number;
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* Arguments for the "sketching.set-geometry-mode" command.
|
|
535
|
+
*/
|
|
536
|
+
export interface SetGeometryModeArgs extends HasMaps {
|
|
537
|
+
/**
|
|
538
|
+
* The geometry mode to switch to. VertiGIS Studio Mobile only supports
|
|
539
|
+
* "line" and "area".
|
|
540
|
+
*/
|
|
541
|
+
editorGeometryMode: EditorGeometryMode | SketchTool;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* Arguments for the "sketching.set-interaction-mode" command.
|
|
545
|
+
*/
|
|
546
|
+
export interface SetInteractionModeArgs extends HasMaps {
|
|
547
|
+
/**
|
|
548
|
+
* The interaction mode to switch to.
|
|
549
|
+
*/
|
|
550
|
+
editorInteractionMode: EditorInteractionMode;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Arguments for the "sketching.start-streaming" command.
|
|
554
|
+
*/
|
|
555
|
+
export interface StartStreamingArgs extends HasMaps {
|
|
556
|
+
/**
|
|
557
|
+
* An optional value indicating, in seconds, how often points should be
|
|
558
|
+
* recorded.
|
|
559
|
+
*/
|
|
560
|
+
interval?: number;
|
|
561
|
+
}
|
|
562
|
+
/**
|
|
563
|
+
* The editor geometry mode.
|
|
564
|
+
*/
|
|
565
|
+
export type EditorGeometryMode = "line" | "area";
|
|
566
|
+
/**
|
|
567
|
+
* The editor interaction mode.
|
|
568
|
+
*/
|
|
569
|
+
export type EditorInteractionMode = "centerCrosshairMode" | "pointerMode";
|
|
570
|
+
/**
|
|
571
|
+
* Settings for a sketch.
|
|
572
|
+
*/
|
|
573
|
+
export interface GeometryEditorSettings {
|
|
574
|
+
/**
|
|
575
|
+
* Whether snapping should be enabled.
|
|
576
|
+
*/
|
|
577
|
+
snappingEnabled?: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* Whether bearing labels should be shown on the map.
|
|
580
|
+
*/
|
|
581
|
+
showBearings?: boolean;
|
|
582
|
+
/**
|
|
583
|
+
* The editor geometry mode.
|
|
584
|
+
*/
|
|
585
|
+
editorGeometryMode?: EditorGeometryMode;
|
|
586
|
+
/**
|
|
587
|
+
* The editor interaction mode.
|
|
588
|
+
*/
|
|
589
|
+
editorInteractionMode?: EditorInteractionMode;
|
|
590
|
+
/**
|
|
591
|
+
* Whether the sketch is using freehand or segment sketching.
|
|
592
|
+
*/
|
|
593
|
+
freehand?: boolean;
|
|
594
|
+
/**
|
|
595
|
+
* Whether the sketch should stop when double clicking.
|
|
596
|
+
*/
|
|
597
|
+
finishOnDoubleClick?: boolean;
|
|
598
|
+
/**
|
|
599
|
+
* Whether the sketch should commit its geometry if another sketch is
|
|
600
|
+
* activated.
|
|
601
|
+
*/
|
|
602
|
+
finishIfInterrupted?: boolean;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* Result returned from the 'sketching.get-active-points' operation.
|
|
606
|
+
*/
|
|
607
|
+
export interface GetActivePointsResult extends GetActiveSketchResult {
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* Result returned from the 'sketching.get-active-sketch' operation.
|
|
611
|
+
*/
|
|
612
|
+
export interface GetActiveSketchResult {
|
|
613
|
+
/**
|
|
614
|
+
* The active graphic(s).
|
|
615
|
+
*/
|
|
616
|
+
graphics: Graphic[] | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* The map associated with the graphics.
|
|
619
|
+
*/
|
|
620
|
+
maps: MapExtension;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* Specifies if a desired point comes before or after a given reference point.
|
|
624
|
+
*/
|
|
625
|
+
export type PointOffset = "before" | "after";
|
|
626
|
+
/**
|
|
627
|
+
* Arguments for the 'sketching.get-adjacent-point' operation.
|
|
628
|
+
*/
|
|
629
|
+
export interface GetAdjacentPointArgs extends HasMaps {
|
|
630
|
+
/**
|
|
631
|
+
* A point geometry that represents a vertex within an active editing
|
|
632
|
+
* graphic.
|
|
633
|
+
*/
|
|
634
|
+
referencePoint: Point;
|
|
635
|
+
/**
|
|
636
|
+
* Specifies if the desired point comes before or after the referencePoint.
|
|
637
|
+
* Defaults to 'after'.
|
|
638
|
+
*/
|
|
639
|
+
relativeOffset?: PointOffset;
|
|
640
|
+
}
|
|
641
|
+
/**
|
|
642
|
+
* Arguments for the "sketching.set-constraints" command.
|
|
643
|
+
*/
|
|
644
|
+
export interface SetConstraintsArgs extends HasMaps {
|
|
645
|
+
/**
|
|
646
|
+
* The constraint for the length of the line between the selected vertex and
|
|
647
|
+
* the new point.
|
|
648
|
+
*/
|
|
649
|
+
length?: number;
|
|
650
|
+
/**
|
|
651
|
+
* The constraint for the angle of the line between the selected vertex and
|
|
652
|
+
* the new point, relative to the reference line. Remains unchanged until
|
|
653
|
+
* set to a different value, or cleared.
|
|
654
|
+
*/
|
|
655
|
+
angle?: number;
|
|
656
|
+
/**
|
|
657
|
+
* A reference line that the angle will be relative to. Defaults to 'north'.
|
|
658
|
+
* Remains unchanged until set again.
|
|
659
|
+
*/
|
|
660
|
+
referenceLine?: ReferenceLine;
|
|
661
|
+
/**
|
|
662
|
+
* Indicates whether constraints will be automatically cleared after a
|
|
663
|
+
* vertex is added or updated. If not set (value is null), then the value
|
|
664
|
+
* will remain unchanged with this operation. If the value has never been
|
|
665
|
+
* set, the default is false. Remains unchanged until set to a different
|
|
666
|
+
* value.
|
|
667
|
+
*/
|
|
668
|
+
autoClear?: boolean;
|
|
669
|
+
/**
|
|
670
|
+
* The units to be used for length. If not specified, the units of the map's
|
|
671
|
+
* spatial reference will be used.
|
|
672
|
+
*/
|
|
673
|
+
units?: LengthUnitsMobile;
|
|
674
|
+
/**
|
|
675
|
+
* Indicates whether the distance calculations will be geodetic or planar.
|
|
676
|
+
* Default is true.
|
|
677
|
+
*/
|
|
678
|
+
geodetic?: boolean;
|
|
679
|
+
/**
|
|
680
|
+
* The geodetic curve type used when calculating the new point. Only applies
|
|
681
|
+
* when geodetic is set to true. Defaults to geodesic.
|
|
682
|
+
*/
|
|
683
|
+
geodeticCurveType?: GeodeticCurveType;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* Arguments for the "sketching.clear-constraints" command.
|
|
687
|
+
*/
|
|
688
|
+
export interface ClearConstraintsArgs extends HasMaps {
|
|
689
|
+
/**
|
|
690
|
+
* Indicates whether the length constraint should be cleared. Defaults to
|
|
691
|
+
* true if not specified.
|
|
692
|
+
*/
|
|
693
|
+
clearLengthConstraint?: boolean;
|
|
694
|
+
/**
|
|
695
|
+
* Indicates whether the angle constraint should be cleared. Defaults to
|
|
696
|
+
* true if not specified.
|
|
697
|
+
*/
|
|
698
|
+
clearAngleConstraint?: boolean;
|
|
699
|
+
}
|
|
700
|
+
/**
|
|
701
|
+
* Arguments for the "sketching.set-snapping-configuration" command.
|
|
702
|
+
*/
|
|
703
|
+
export interface SetSnappingConfigurationArgs extends HasMaps {
|
|
704
|
+
/**
|
|
705
|
+
* The snapping properties to set.
|
|
706
|
+
*/
|
|
707
|
+
config: SnappingProperties;
|
|
708
|
+
/**
|
|
709
|
+
* Whether the config should be replace, or merged. Defaults to "merge".
|
|
710
|
+
*/
|
|
711
|
+
mode?: "replace" | "merge";
|
|
712
|
+
}
|
|
713
|
+
/**
|
|
714
|
+
* Arguments for the "sketching.set-topology-configuration" command.
|
|
715
|
+
*/
|
|
716
|
+
export interface SetTopologyConfigurationArgs extends HasMaps {
|
|
717
|
+
/**
|
|
718
|
+
* The topology properties to set.
|
|
719
|
+
*/
|
|
720
|
+
config: TopologyProperties;
|
|
721
|
+
/**
|
|
722
|
+
* Whether the config should be replace, or merged. Defaults to "merge".
|
|
723
|
+
*/
|
|
724
|
+
mode?: "replace" | "merge";
|
|
725
|
+
}
|
|
726
|
+
export declare class SketchingOperations extends OperationRegistry {
|
|
727
|
+
protected readonly _prefix = "sketching";
|
|
728
|
+
/**
|
|
729
|
+
* Allows the user to create geometry by sketching on a map. Returns the
|
|
730
|
+
* geometry that was drawn, along with the map that it was drawn on.
|
|
731
|
+
*/
|
|
732
|
+
get captureGeometry(): Operation<CaptureGeometryArgs, CaptureGeometryResult>;
|
|
733
|
+
/**
|
|
734
|
+
* Allows the user to edit the symbology used by the graphics actively being
|
|
735
|
+
* edited. Web only.
|
|
736
|
+
*
|
|
737
|
+
* @webOnly
|
|
738
|
+
*/
|
|
739
|
+
get editActiveSymbol(): Operation<void, EditSymbolResult | undefined>;
|
|
740
|
+
/**
|
|
741
|
+
* Allows the user to edit an existing geometry by drawing on a map. Returns
|
|
742
|
+
* the geometry that was edited, or the supplied feature with the altered
|
|
743
|
+
* geometry applied, along with the map that it was drawn on.
|
|
744
|
+
*/
|
|
745
|
+
get editGeometry(): Operation<EditGeometryArgs, EditGeometryResult>;
|
|
746
|
+
/**
|
|
747
|
+
* Allows the user to move an existing geometry by a specified amount.
|
|
748
|
+
* Returns the altered geometry or the supplied feature with altered
|
|
749
|
+
* geometry applied. Will also pass through any map or symbol associated
|
|
750
|
+
* with the command chain, but only the map is required for this operation.
|
|
751
|
+
* Web only.
|
|
752
|
+
*
|
|
753
|
+
* @webOnly
|
|
754
|
+
*/
|
|
755
|
+
get moveGeometry(): Operation<MoveGeometryArgs, GeometryOperationBase>;
|
|
756
|
+
/**
|
|
757
|
+
* Allows the user to scale and mirror an existing geometry on either axis.
|
|
758
|
+
* Returns the altered geometry or the supplied feature with altered
|
|
759
|
+
* geometry applied. Will also pass through any map or symbol associated
|
|
760
|
+
* with the command chain, but they are not required for this operation. Web
|
|
761
|
+
* only.
|
|
762
|
+
*
|
|
763
|
+
* @webOnly
|
|
764
|
+
*/
|
|
765
|
+
get scaleGeometry(): Operation<ScaleGeometryArgs, GeometryOperationBase>;
|
|
766
|
+
/**
|
|
767
|
+
* Allows the user to rotate an existing geometry. Returns the altered
|
|
768
|
+
* geometry or the supplied feature with altered geometry applied. Will also
|
|
769
|
+
* pass through any map or symbol associated with the command chain, but
|
|
770
|
+
* they are not required for this operation. Web only.
|
|
771
|
+
*
|
|
772
|
+
* @webOnly
|
|
773
|
+
*/
|
|
774
|
+
get rotateGeometry(): Operation<RotateGeometryArgs, GeometryOperationBase>;
|
|
775
|
+
/**
|
|
776
|
+
* Stops geometry capturing or editing on a given map. Returns the current
|
|
777
|
+
* geometry. If validateGeometry parameter is true and geometry is invalid,
|
|
778
|
+
* the operation will return null.
|
|
779
|
+
*/
|
|
780
|
+
get stop(): Operation<StopGeometryEditArgs | void, CaptureGeometryResult>;
|
|
781
|
+
/**
|
|
782
|
+
* Deprecated - Mobile users should rather use "geometry.add-point"; Web
|
|
783
|
+
* users should use "sketching.add-point" or "sketching.insert-point"
|
|
784
|
+
* instead.
|
|
785
|
+
*
|
|
786
|
+
* @deprecated
|
|
787
|
+
*/
|
|
788
|
+
get addNodeToGeometry(): Operation<AddNodeToGeometryArgs, Geometry>;
|
|
789
|
+
/**
|
|
790
|
+
* Returns the active sketch graphic from a map. Web only.
|
|
791
|
+
*
|
|
792
|
+
* @webOnly
|
|
793
|
+
*/
|
|
794
|
+
get getActiveSketch(): Operation<void, GetActiveSketchResult>;
|
|
795
|
+
/**
|
|
796
|
+
* Deprecated - use 'sketching.get-active-points' instead. Web only.
|
|
797
|
+
*
|
|
798
|
+
* @deprecated
|
|
799
|
+
* @webOnly
|
|
800
|
+
*/
|
|
801
|
+
get getActiveNode(): Operation<Maps, GetActivePointsResult>;
|
|
802
|
+
/**
|
|
803
|
+
* Returns the active point graphics of the active sketch or edit session on
|
|
804
|
+
* a map. Web only.
|
|
805
|
+
*
|
|
806
|
+
* @webOnly
|
|
807
|
+
*/
|
|
808
|
+
get getActivePoints(): Operation<Maps, GetActivePointsResult>;
|
|
809
|
+
/**
|
|
810
|
+
* Return the adjacent point graphic(s), relative to a given vertex that's a
|
|
811
|
+
* part of an active editing or sketching session. This operation is only
|
|
812
|
+
* supported for Polyline and Polygon geometries. Web only.
|
|
813
|
+
*
|
|
814
|
+
* @webOnly
|
|
815
|
+
*/
|
|
816
|
+
get getAdjacentPoint(): Operation<GetAdjacentPointArgs, GetActiveSketchResult>;
|
|
817
|
+
/**
|
|
818
|
+
* Checks whether streaming is active. Mobile only.
|
|
819
|
+
*
|
|
820
|
+
* @mobileOnly
|
|
821
|
+
*/
|
|
822
|
+
get isStreaming(): Operation<HasMaps, boolean>;
|
|
823
|
+
}
|
|
824
|
+
export declare class SketchingCommands extends CommandRegistry {
|
|
825
|
+
protected readonly _prefix = "sketching";
|
|
826
|
+
/**
|
|
827
|
+
* Set the snapping default to 'on' for all subsequent operations. Web only.
|
|
828
|
+
*
|
|
829
|
+
* @webOnly
|
|
830
|
+
*/
|
|
831
|
+
get activateSnapping(): Command<void>;
|
|
832
|
+
/**
|
|
833
|
+
* Set the topology default to 'on' for all subsequent operations. Web only.
|
|
834
|
+
*
|
|
835
|
+
* @webOnly
|
|
836
|
+
*/
|
|
837
|
+
get activateTopology(): Command<void>;
|
|
838
|
+
/**
|
|
839
|
+
* Cancels the current geometry edit or capture operation. Web only.
|
|
840
|
+
*
|
|
841
|
+
* @webOnly
|
|
842
|
+
*/
|
|
843
|
+
get cancel(): Command<void>;
|
|
844
|
+
/**
|
|
845
|
+
* Set the snapping default to 'off' for all subsequent operations. Web
|
|
846
|
+
* only.
|
|
847
|
+
*
|
|
848
|
+
* @webOnly
|
|
849
|
+
*/
|
|
850
|
+
get deactivateSnapping(): Command<void>;
|
|
851
|
+
/**
|
|
852
|
+
* Set the topology default to 'off' for all subsequent operations. Web
|
|
853
|
+
* only.
|
|
854
|
+
*
|
|
855
|
+
* @webOnly
|
|
856
|
+
*/
|
|
857
|
+
get deactivateTopology(): Command<void>;
|
|
858
|
+
/**
|
|
859
|
+
* Undoes the last edit while editing a geometry.
|
|
860
|
+
*/
|
|
861
|
+
get undo(): Command<HasMaps>;
|
|
862
|
+
/**
|
|
863
|
+
* Redoes the last undone edit while editing a geometry.
|
|
864
|
+
*/
|
|
865
|
+
get redo(): Command<HasMaps>;
|
|
866
|
+
/**
|
|
867
|
+
* Sets the geometry mode of the geometry editor.
|
|
868
|
+
*/
|
|
869
|
+
get setGeometryMode(): Command<SetGeometryModeArgs>;
|
|
870
|
+
/**
|
|
871
|
+
* Sets the global snapping configuration.
|
|
872
|
+
*/
|
|
873
|
+
get setSnappingConfiguration(): Command<SetSnappingConfigurationArgs>;
|
|
874
|
+
/**
|
|
875
|
+
* Sets the global snapping configuration. Web only.
|
|
876
|
+
*
|
|
877
|
+
* @webOnly
|
|
878
|
+
*/
|
|
879
|
+
get setTopologyConfiguration(): Command<SetTopologyConfigurationArgs>;
|
|
880
|
+
/**
|
|
881
|
+
* Adds a point at the center of the map while editing a geometry. Works in
|
|
882
|
+
* centerCrosshair mode only. Mobile only.
|
|
883
|
+
*
|
|
884
|
+
* @mobileOnly
|
|
885
|
+
*/
|
|
886
|
+
get addPointAtCenter(): Command<HasMaps>;
|
|
887
|
+
/**
|
|
888
|
+
* Adds a point at the user's current location while editing a geometry.
|
|
889
|
+
* Mobile only.
|
|
890
|
+
*
|
|
891
|
+
* @mobileOnly
|
|
892
|
+
*/
|
|
893
|
+
get addPointAtCurrentLocation(): Command<HasMaps>;
|
|
894
|
+
/**
|
|
895
|
+
* Sets a point at the user's current location while editing a geometry. In
|
|
896
|
+
* this context, "set" means to either add a point at the current location,
|
|
897
|
+
* or update the currently selected point to be the user's current location,
|
|
898
|
+
* depending on what edit mode the user is in. Mobile only.
|
|
899
|
+
*
|
|
900
|
+
* @mobileOnly
|
|
901
|
+
*/
|
|
902
|
+
get setPointAtCurrentLocation(): Command<HasMaps>;
|
|
903
|
+
/**
|
|
904
|
+
* If a point is supplied while a sketching or editing operation is active,
|
|
905
|
+
* the vertex at that point will be deleted from the current geometry. If no
|
|
906
|
+
* point is supplied, any active points in the session will be deleted. If
|
|
907
|
+
* there are no active points in the session, the entire geometry will be
|
|
908
|
+
* deleted.
|
|
909
|
+
*/
|
|
910
|
+
get delete(): Command<void | DeleteGeometryArgs>;
|
|
911
|
+
/**
|
|
912
|
+
* Deprecated - use 'sketching.move-point' instead. Web only.
|
|
913
|
+
*
|
|
914
|
+
* @deprecated
|
|
915
|
+
* @webOnly
|
|
916
|
+
*/
|
|
917
|
+
get moveNode(): Command<MoveNodeArgs>;
|
|
918
|
+
/**
|
|
919
|
+
* Moves a point within an active sketch to a new location. Web only.
|
|
920
|
+
*
|
|
921
|
+
* @webOnly
|
|
922
|
+
*/
|
|
923
|
+
get movePoint(): Command<MovePointArgs>;
|
|
924
|
+
/**
|
|
925
|
+
* Deprecated - use 'sketching.set-active-points' instead. Web only.
|
|
926
|
+
*
|
|
927
|
+
* @deprecated
|
|
928
|
+
* @webOnly
|
|
929
|
+
*/
|
|
930
|
+
get switchActiveNode(): Command<SwitchActiveNodeArgs>;
|
|
931
|
+
/**
|
|
932
|
+
* Switches the active point of an active sketch. Web only.
|
|
933
|
+
*
|
|
934
|
+
* @webOnly
|
|
935
|
+
*/
|
|
936
|
+
get setActivePoints(): Command<SetActivePointsArgs>;
|
|
937
|
+
/**
|
|
938
|
+
* Sets the interaction mode of the geometry editor. Mobile only.
|
|
939
|
+
*
|
|
940
|
+
* @mobileOnly
|
|
941
|
+
*/
|
|
942
|
+
get setInteractionMode(): Command<SetInteractionModeArgs>;
|
|
943
|
+
/**
|
|
944
|
+
* Enables free scaling while editing geometries. Web only.
|
|
945
|
+
*
|
|
946
|
+
* @webOnly
|
|
947
|
+
*/
|
|
948
|
+
get enableFreeScaleMode(): Command<void>;
|
|
949
|
+
/**
|
|
950
|
+
* Disables free scaling while editing geometries. Web only.
|
|
951
|
+
*
|
|
952
|
+
* @webOnly
|
|
953
|
+
*/
|
|
954
|
+
get disableFreeScaleMode(): Command<void>;
|
|
955
|
+
/**
|
|
956
|
+
* Enables more precise inputs while editing geometries. Web only.
|
|
957
|
+
*
|
|
958
|
+
* @webOnly
|
|
959
|
+
*/
|
|
960
|
+
get enablePrecisionMode(): Command<void>;
|
|
961
|
+
/**
|
|
962
|
+
* Disables more precise inputs while editing geometries. Web only.
|
|
963
|
+
*
|
|
964
|
+
* @webOnly
|
|
965
|
+
*/
|
|
966
|
+
get disablePrecisionMode(): Command<void>;
|
|
967
|
+
/**
|
|
968
|
+
* Sets constraints on the active sketch. Mobile only.
|
|
969
|
+
*
|
|
970
|
+
* @mobileOnly
|
|
971
|
+
*/
|
|
972
|
+
get setConstraints(): Command<SetConstraintsArgs>;
|
|
973
|
+
/**
|
|
974
|
+
* Clears constraints that have been previously set. Mobile only.
|
|
975
|
+
*
|
|
976
|
+
* @mobileOnly
|
|
977
|
+
*/
|
|
978
|
+
get clearConstraints(): Command<ClearConstraintsArgs>;
|
|
979
|
+
/**
|
|
980
|
+
* Inserts a point into a polygon, polyline, or multipoint at the specified
|
|
981
|
+
* index. If the partIndex is null, then the last part is used. If the
|
|
982
|
+
* pointIndex is null, then the new point is inserted at the end.
|
|
983
|
+
*/
|
|
984
|
+
get insertPoint(): Command<InsertPointArgs>;
|
|
985
|
+
/**
|
|
986
|
+
* Adds a point to polygon, polyline, or multipoint using the selected index
|
|
987
|
+
* as the point to insert after.
|
|
988
|
+
*/
|
|
989
|
+
get addPoint(): Command<AddPointArgs>;
|
|
990
|
+
/**
|
|
991
|
+
* Starts streaming: recording your location at regular intervals and adding
|
|
992
|
+
* the collected points to the currently active geometry editor. Mobile
|
|
993
|
+
* only.
|
|
994
|
+
*
|
|
995
|
+
* @mobileOnly
|
|
996
|
+
*/
|
|
997
|
+
get startStreaming(): Command<StartStreamingArgs>;
|
|
998
|
+
/**
|
|
999
|
+
* Stops streaming. Mobile only.
|
|
1000
|
+
*
|
|
1001
|
+
* @mobileOnly
|
|
1002
|
+
*/
|
|
1003
|
+
get stopStreaming(): Command<HasMaps>;
|
|
1004
|
+
}
|
|
1005
|
+
export declare class SketchingEvents extends EventRegistry {
|
|
1006
|
+
protected readonly _prefix = "sketching";
|
|
1007
|
+
/**
|
|
1008
|
+
* Raised when streaming has begun. Mobile only.
|
|
1009
|
+
*
|
|
1010
|
+
* @mobileOnly
|
|
1011
|
+
*/
|
|
1012
|
+
get streamingStarted(): Event<HasMaps>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Raised when streaming has stopped. Mobile only.
|
|
1015
|
+
*
|
|
1016
|
+
* @mobileOnly
|
|
1017
|
+
*/
|
|
1018
|
+
get streamingStopped(): Event<HasMaps>;
|
|
1019
|
+
}
|