@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,499 +1,499 @@
|
|
|
1
|
-
import type Color from "@arcgis/core/Color";
|
|
2
|
-
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
3
|
-
import type Point from "@arcgis/core/geometry/Point";
|
|
4
|
-
import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol.js";
|
|
5
|
-
import type { SpatialReferenceJson } from "@vertigis/arcgis-extensions/json/SpatialReferenceJson.js";
|
|
6
|
-
import type { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
|
|
7
|
-
import type { Command } from "../Command.js";
|
|
8
|
-
import { CommandRegistry } from "../CommandRegistry.js";
|
|
9
|
-
import type { TimeSpan } from "../DotNetTypes.js";
|
|
10
|
-
import type { Event } from "../Event.js";
|
|
11
|
-
import { EventRegistry } from "../EventRegistry.js";
|
|
12
|
-
import type { Operation } from "../Operation.js";
|
|
13
|
-
import { OperationRegistry } from "../OperationRegistry.js";
|
|
14
|
-
import type { HasMaps, Maps } from "../common.js";
|
|
15
|
-
import type { CoordinateTransformation } from "./map.js";
|
|
16
|
-
/**
|
|
17
|
-
* Arguments for the "geolocation.accuracy-changed" event.
|
|
18
|
-
*/
|
|
19
|
-
export interface GeolocateAccuracyChangedEventArgs {
|
|
20
|
-
/**
|
|
21
|
-
* The current geolocation accuracy, in meters.
|
|
22
|
-
*/
|
|
23
|
-
accuracy: number;
|
|
24
|
-
}
|
|
25
|
-
/**
|
|
26
|
-
* Arguments for the "geolocation.metadata-changed" event.
|
|
27
|
-
*/
|
|
28
|
-
export interface GeolocateMetadataChangedEventArgs {
|
|
29
|
-
/**
|
|
30
|
-
* The GNSS position metadata.
|
|
31
|
-
*/
|
|
32
|
-
nmeaProperties: NmeaProperties;
|
|
33
|
-
}
|
|
34
|
-
export interface NmeaProperties {
|
|
35
|
-
fixTimeUtc?: Date;
|
|
36
|
-
latitude?: number;
|
|
37
|
-
longitude?: number;
|
|
38
|
-
altitude?: number;
|
|
39
|
-
horizontalDilutionOfPrecision?: number;
|
|
40
|
-
verticalDilutionOfPrecision?: number;
|
|
41
|
-
positionDilutionOfPrecision?: number;
|
|
42
|
-
estimatedVerticalAccuracy?: number;
|
|
43
|
-
preciseVerticalAccuracy?: number;
|
|
44
|
-
estimatedHorizontalAccuracy?: number;
|
|
45
|
-
preciseHorizontalAccuracy?: number;
|
|
46
|
-
satellitesInView?: number;
|
|
47
|
-
satellitesInUse?: number;
|
|
48
|
-
satelliteIds?: number[];
|
|
49
|
-
heightOfGeoid?: number;
|
|
50
|
-
correctionAge?: TimeSpan;
|
|
51
|
-
stationId?: number;
|
|
52
|
-
speed?: number;
|
|
53
|
-
course?: number;
|
|
54
|
-
magneticVariation?: number;
|
|
55
|
-
fixQuality?: FixQuality;
|
|
56
|
-
fixMethod?: string;
|
|
57
|
-
fixMode?: GnssFixMode;
|
|
58
|
-
}
|
|
59
|
-
/**
|
|
60
|
-
* Current GNSS device settings.
|
|
61
|
-
*/
|
|
62
|
-
export interface GnssDeviceSettings {
|
|
63
|
-
}
|
|
64
|
-
/**
|
|
65
|
-
* Result for the "geolocation.get-current-state" operation.
|
|
66
|
-
*/
|
|
67
|
-
export interface GeolocateCurrentState {
|
|
68
|
-
/**
|
|
69
|
-
* Whether or not a position is actively being reported and received.
|
|
70
|
-
*/
|
|
71
|
-
isGeolocationAvailable: boolean;
|
|
72
|
-
/**
|
|
73
|
-
* Whether or not the app has been permitted to use geolocation according to
|
|
74
|
-
* the OS level settings.
|
|
75
|
-
*/
|
|
76
|
-
isGeolocationEnabled: boolean;
|
|
77
|
-
/**
|
|
78
|
-
* The current accuracy in meters.
|
|
79
|
-
*/
|
|
80
|
-
accuracy: number;
|
|
81
|
-
/**
|
|
82
|
-
* The current position.
|
|
83
|
-
*/
|
|
84
|
-
position: Point;
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* Arguments for the "geolocation.status-changed" event.
|
|
88
|
-
*/
|
|
89
|
-
export interface GeolocationStatusChangedEventArgs {
|
|
90
|
-
/**
|
|
91
|
-
* Indicates whether the geolocation is now enabled.
|
|
92
|
-
*/
|
|
93
|
-
isEnabled: boolean;
|
|
94
|
-
}
|
|
95
|
-
/**
|
|
96
|
-
* Arguments for the "geolocation.display-mode-changed" event.
|
|
97
|
-
*/
|
|
98
|
-
export interface LocationDisplayModeChangedEventArgs {
|
|
99
|
-
/**
|
|
100
|
-
* The location display mode.
|
|
101
|
-
*/
|
|
102
|
-
locationDisplayMode: GeolocateState;
|
|
103
|
-
}
|
|
104
|
-
/**
|
|
105
|
-
* The geolocation state / mode.
|
|
106
|
-
*/
|
|
107
|
-
export type GeolocateState = "Disabled" | "Enabled" | "Recentering" | "RecenteringAndReorienting";
|
|
108
|
-
/**
|
|
109
|
-
* Arguments for geolocation events such as "geolocation.position-acquired" and
|
|
110
|
-
* "geolocation.position-lost".
|
|
111
|
-
*/
|
|
112
|
-
export interface GeolocationEvent {
|
|
113
|
-
/**
|
|
114
|
-
* The GNSS source associated with the raised geolocation event. Mobile
|
|
115
|
-
* only.
|
|
116
|
-
*
|
|
117
|
-
* @mobileOnly
|
|
118
|
-
*/
|
|
119
|
-
gnssDeviceConnectionInfo?: GnssDeviceConnectionInfo;
|
|
120
|
-
}
|
|
121
|
-
/**
|
|
122
|
-
* A geolocation source.
|
|
123
|
-
*/
|
|
124
|
-
export interface GnssDeviceConnectionInfo {
|
|
125
|
-
/**
|
|
126
|
-
* Name of the GNSS device.
|
|
127
|
-
*/
|
|
128
|
-
deviceName: string;
|
|
129
|
-
/**
|
|
130
|
-
* Full name of the GNSS device.
|
|
131
|
-
*/
|
|
132
|
-
deviceFullName: string;
|
|
133
|
-
/**
|
|
134
|
-
* The type of the device. Options are Integrated, Bluetooth, USB, and
|
|
135
|
-
* Emulator.
|
|
136
|
-
*/
|
|
137
|
-
deviceType: GnssDeviceType;
|
|
138
|
-
/**
|
|
139
|
-
* The device settings, including the correction service's spatial
|
|
140
|
-
* reference, the desired datum transformation, and the device's antenna
|
|
141
|
-
* height.
|
|
142
|
-
*/
|
|
143
|
-
settings: GnssDeviceSettings;
|
|
144
|
-
}
|
|
145
|
-
/**
|
|
146
|
-
* Arguments for the geolocation.set-location-symbol command.
|
|
147
|
-
*/
|
|
148
|
-
export interface SetLocationSymbolArgs {
|
|
149
|
-
/**
|
|
150
|
-
* The color to use for the location marker's fill and the accuracy circle's
|
|
151
|
-
* outline.
|
|
152
|
-
*/
|
|
153
|
-
color?: Color | ColorJson | string;
|
|
154
|
-
/**
|
|
155
|
-
* The symbol to use for the outline of the location marker.
|
|
156
|
-
*/
|
|
157
|
-
outline?: SimpleLineSymbol;
|
|
158
|
-
/**
|
|
159
|
-
* The size to use for the location marker.
|
|
160
|
-
*/
|
|
161
|
-
size?: number;
|
|
162
|
-
/**
|
|
163
|
-
* The style to use for the location marker. Valid values are: circle,
|
|
164
|
-
* cross, diamond, square, triangle and X.
|
|
165
|
-
*/
|
|
166
|
-
style?: string;
|
|
167
|
-
/**
|
|
168
|
-
* If true, all other properties will be ignored and the location symbol
|
|
169
|
-
* will be reset to the default symbol.
|
|
170
|
-
*/
|
|
171
|
-
default?: boolean;
|
|
172
|
-
}
|
|
173
|
-
type GnssDeviceType = "integrated" | "bluetooth" | "usb" | "emulator";
|
|
174
|
-
/**
|
|
175
|
-
* Arguments for getting a list of geographic transformations.
|
|
176
|
-
*/
|
|
177
|
-
export interface GetTransformationArgs {
|
|
178
|
-
/**
|
|
179
|
-
* The input spatial reference to transform. For example, the spatial
|
|
180
|
-
* reference of a GNSS receiver. If unspecified, defaults to WGS84.
|
|
181
|
-
*/
|
|
182
|
-
inputSpatialReference?: SpatialReferenceJson;
|
|
183
|
-
/**
|
|
184
|
-
* The desired output spatial reference of the transformations. For example,
|
|
185
|
-
* the spatial reference of the map. If unspecified, the spatial reference
|
|
186
|
-
* of the first available map will be used.
|
|
187
|
-
*/
|
|
188
|
-
outputSpatialReference?: SpatialReferenceJson;
|
|
189
|
-
/**
|
|
190
|
-
* The area of interest. If provided, this will be used to order the list of
|
|
191
|
-
* valid transformations in order of best-fit.
|
|
192
|
-
*/
|
|
193
|
-
area?: Geometry;
|
|
194
|
-
}
|
|
195
|
-
/**
|
|
196
|
-
* Event args for the geolocation.gnss-lock-status-changed event.
|
|
197
|
-
*/
|
|
198
|
-
export interface GnssLockStateEventArgs {
|
|
199
|
-
/**
|
|
200
|
-
* The lock status.
|
|
201
|
-
*/
|
|
202
|
-
lockStatus: GnssLockStatus;
|
|
203
|
-
}
|
|
204
|
-
/**
|
|
205
|
-
* Event args for the geolocation.gnss-transformation-changed event.
|
|
206
|
-
*/
|
|
207
|
-
export interface GnssDeviceTransformationOverrideEventArgs {
|
|
208
|
-
/**
|
|
209
|
-
* The WKID of the transformation.
|
|
210
|
-
*/
|
|
211
|
-
wkid: number;
|
|
212
|
-
/**
|
|
213
|
-
* The data transformation name.
|
|
214
|
-
*/
|
|
215
|
-
name: string;
|
|
216
|
-
}
|
|
217
|
-
/**
|
|
218
|
-
* The quality of the GNSS fix.
|
|
219
|
-
*/
|
|
220
|
-
export type FixQuality = "Invalid" | "GpsFix" | "DgpsFix" | "PpsFix" | "Rtk" | "FloatRtk" | "Estimated" | "ManualInput" | "Simulation";
|
|
221
|
-
/**
|
|
222
|
-
* The GNSS fix mode.
|
|
223
|
-
*/
|
|
224
|
-
export interface GnssFixMode {
|
|
225
|
-
/**
|
|
226
|
-
* The GPGSA fix mode.
|
|
227
|
-
*/
|
|
228
|
-
mode: GpgsaFixMode;
|
|
229
|
-
/**
|
|
230
|
-
* The display text.
|
|
231
|
-
*/
|
|
232
|
-
displayText: string;
|
|
233
|
-
}
|
|
234
|
-
/**
|
|
235
|
-
* Global Positioning Global navigation satellite System Agency fix mode.
|
|
236
|
-
*/
|
|
237
|
-
export type GpgsaFixMode = "NotAvailable" | "Fix2D" | "Fix3";
|
|
238
|
-
/**
|
|
239
|
-
* GNSS lock status.
|
|
240
|
-
*/
|
|
241
|
-
export type GnssLockStatus =
|
|
242
|
-
/**
|
|
243
|
-
* Good.
|
|
244
|
-
*/
|
|
245
|
-
0
|
|
246
|
-
/**
|
|
247
|
-
* UncorrectedPosition.
|
|
248
|
-
*/
|
|
249
|
-
| 1
|
|
250
|
-
/**
|
|
251
|
-
* EstimatedAccuracy.
|
|
252
|
-
*/
|
|
253
|
-
| 2
|
|
254
|
-
/**
|
|
255
|
-
* LostConnection.
|
|
256
|
-
*/
|
|
257
|
-
| 4
|
|
258
|
-
/**
|
|
259
|
-
* NoLocation.
|
|
260
|
-
*/
|
|
261
|
-
| 16
|
|
262
|
-
/**
|
|
263
|
-
* Integrated.
|
|
264
|
-
*/
|
|
265
|
-
| 32;
|
|
266
|
-
/**
|
|
267
|
-
* Event args for the geolocation.gnss-antenna-height-changed event.
|
|
268
|
-
*/
|
|
269
|
-
export interface GnssDeviceAntennaHeightEventArgs {
|
|
270
|
-
/**
|
|
271
|
-
* The antenna height.
|
|
272
|
-
*/
|
|
273
|
-
height: number;
|
|
274
|
-
}
|
|
275
|
-
export declare class GeolocationCommands extends CommandRegistry {
|
|
276
|
-
protected readonly _prefix = "geolocation";
|
|
277
|
-
/**
|
|
278
|
-
* Centers the map on the user's current location and keeps the location
|
|
279
|
-
* centered as it moves around. The maps parameter is only supported in
|
|
280
|
-
* VertiGIS Studio Mobile. In VertiGIS Studio Web, all maps are affected.
|
|
281
|
-
*/
|
|
282
|
-
get autoRecenter(): Command<Maps | void>;
|
|
283
|
-
/**
|
|
284
|
-
* Centers the map on the user's current location and updates the
|
|
285
|
-
* orientation of the map to face the direction of the device. Keeps the
|
|
286
|
-
* location centered as it moves around. Returns whether guiding started
|
|
287
|
-
* successfully. Mobile only.
|
|
288
|
-
*
|
|
289
|
-
* @mobileOnly
|
|
290
|
-
*/
|
|
291
|
-
get autoRecenterAndReorient(): Command<HasMaps>;
|
|
292
|
-
/**
|
|
293
|
-
* Show the user's location while the location is in the map's extent.
|
|
294
|
-
*/
|
|
295
|
-
get displayLocation(): Command;
|
|
296
|
-
/**
|
|
297
|
-
* Turns off geolocation.
|
|
298
|
-
*/
|
|
299
|
-
get turnOffGeolocation(): Command;
|
|
300
|
-
/**
|
|
301
|
-
* Displays the GNSS device settings view. Mobile only.
|
|
302
|
-
*
|
|
303
|
-
* @mobileOnly
|
|
304
|
-
*/
|
|
305
|
-
get displayDeviceSettings(): Command<GnssDeviceConnectionInfo>;
|
|
306
|
-
/**
|
|
307
|
-
* Displays the GNSS device metadata view. Mobile only.
|
|
308
|
-
*
|
|
309
|
-
* @mobileOnly
|
|
310
|
-
*/
|
|
311
|
-
get displayDeviceMetadata(): Command;
|
|
312
|
-
/**
|
|
313
|
-
* Displays the GNSS device selection view. Mobile only.
|
|
314
|
-
*
|
|
315
|
-
* @mobileOnly
|
|
316
|
-
*/
|
|
317
|
-
get displayDeviceSelection(): Command;
|
|
318
|
-
/**
|
|
319
|
-
* Applies a datum transformation to the current GNSS device. Mobile only.
|
|
320
|
-
*
|
|
321
|
-
* @mobileOnly
|
|
322
|
-
*/
|
|
323
|
-
get applyDatumTransformation(): Command<CoordinateTransformation | string | number | number[]>;
|
|
324
|
-
/**
|
|
325
|
-
* Modifies the location display symbol. Mobile only.
|
|
326
|
-
*
|
|
327
|
-
* @mobileOnly
|
|
328
|
-
*/
|
|
329
|
-
get setLocationSymbol(): Command<SetLocationSymbolArgs>;
|
|
330
|
-
}
|
|
331
|
-
export declare class GeolocationOperations extends OperationRegistry {
|
|
332
|
-
protected readonly _prefix = "geolocation";
|
|
333
|
-
/**
|
|
334
|
-
* Updates the currently active GNSS receiver. Mobile only.
|
|
335
|
-
*
|
|
336
|
-
* @mobileOnly
|
|
337
|
-
*/
|
|
338
|
-
get changeSource(): Operation<GnssDeviceConnectionInfo, void>;
|
|
339
|
-
/**
|
|
340
|
-
* Gets the currently active geolocation source. Mobile only.
|
|
341
|
-
*
|
|
342
|
-
* @mobileOnly
|
|
343
|
-
*/
|
|
344
|
-
get getActiveSource(): Operation<GnssDeviceConnectionInfo>;
|
|
345
|
-
/**
|
|
346
|
-
* Gets the list of currently available geolocation sources. Includes
|
|
347
|
-
* integrated receivers, GNSS devices, and emulators. Mobile only.
|
|
348
|
-
*
|
|
349
|
-
* @mobileOnly
|
|
350
|
-
*/
|
|
351
|
-
get getAllSources(): Operation<boolean, GnssDeviceConnectionInfo[]>;
|
|
352
|
-
/**
|
|
353
|
-
* Gets the current geolocate state.
|
|
354
|
-
*/
|
|
355
|
-
get getCurrentState(): Operation<void, GeolocateCurrentState>;
|
|
356
|
-
/**
|
|
357
|
-
* Returns whether integrated location services have been permitted via app
|
|
358
|
-
* or browser permissions.
|
|
359
|
-
*/
|
|
360
|
-
get getLocationPermissionsEnabled(): Operation<boolean>;
|
|
361
|
-
/**
|
|
362
|
-
* Returns the current user position. This Operation can block while the
|
|
363
|
-
* user is prompted for permission, as such it is considered best practice
|
|
364
|
-
* not to perform this during startup.
|
|
365
|
-
*/
|
|
366
|
-
get getPosition(): Operation<void, Point>;
|
|
367
|
-
/**
|
|
368
|
-
* Returns a list of valid coordinate transformations for given input and
|
|
369
|
-
* output spatial references. Mobile only.
|
|
370
|
-
*
|
|
371
|
-
* @mobileOnly
|
|
372
|
-
*/
|
|
373
|
-
get getCoordinateTransformations(): Operation<GetTransformationArgs, CoordinateTransformation[]>;
|
|
374
|
-
}
|
|
375
|
-
export declare class GeolocationEvents extends EventRegistry {
|
|
376
|
-
protected readonly _prefix = "geolocation";
|
|
377
|
-
/**
|
|
378
|
-
* Raised when geolocation is activated and the accuracy of geolocation
|
|
379
|
-
* changes.
|
|
380
|
-
*/
|
|
381
|
-
get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
|
|
382
|
-
/**
|
|
383
|
-
* Raised when a GNSS receiver is active and metadata about the device or
|
|
384
|
-
* location change. Mobile only.
|
|
385
|
-
*
|
|
386
|
-
* @mobileOnly
|
|
387
|
-
*/
|
|
388
|
-
get metadataChanged(): Event<GeolocateMetadataChangedEventArgs>;
|
|
389
|
-
/**
|
|
390
|
-
* Raised when geolocation enters auto recenter mode. For VertiGIS Studio
|
|
391
|
-
* Web Viewer, the event will have no parameter (all maps are always
|
|
392
|
-
* affected).
|
|
393
|
-
*/
|
|
394
|
-
get autoRecenterStarted(): Event<HasMaps | void>;
|
|
395
|
-
/**
|
|
396
|
-
* Raised when the user changes the geolocation mode to
|
|
397
|
-
* recenter-and-reorient (updates map orientation to match device
|
|
398
|
-
* direction). Mobile only.
|
|
399
|
-
*
|
|
400
|
-
* @mobileOnly
|
|
401
|
-
*/
|
|
402
|
-
get autoRecenterAndReorientStarted(): Event<HasMaps>;
|
|
403
|
-
/**
|
|
404
|
-
* Raised when geolocation leaves auto recenter mode. For VertiGIS Studio
|
|
405
|
-
* Web Viewer, the event will have no parameter (all maps are always
|
|
406
|
-
* affected).
|
|
407
|
-
*/
|
|
408
|
-
get autoRecenterStopped(): Event<HasMaps | void>;
|
|
409
|
-
/**
|
|
410
|
-
* Raised when the user changes the geolocation mode to not
|
|
411
|
-
* recenter-and-reorient. Mobile only.
|
|
412
|
-
*
|
|
413
|
-
* @mobileOnly
|
|
414
|
-
*/
|
|
415
|
-
get autoRecenterAndReorientStopped(): Event<HasMaps>;
|
|
416
|
-
/**
|
|
417
|
-
* Raised when detection of connected GNSS receivers begins. Mobile only.
|
|
418
|
-
*
|
|
419
|
-
* @mobileOnly
|
|
420
|
-
*/
|
|
421
|
-
get gnssDeviceDetectionStarted(): Event;
|
|
422
|
-
/**
|
|
423
|
-
* Raised when detection of connected GNSS receivers ends. Mobile only.
|
|
424
|
-
*
|
|
425
|
-
* @mobileOnly
|
|
426
|
-
*/
|
|
427
|
-
get gnssDeviceDetectionStopped(): Event;
|
|
428
|
-
/**
|
|
429
|
-
* Raised when the lock status of an active GNSS device changes. Mobile
|
|
430
|
-
* only.
|
|
431
|
-
*
|
|
432
|
-
* @mobileOnly
|
|
433
|
-
*/
|
|
434
|
-
get gnssLockStatusChanged(): Event<GnssLockStateEventArgs>;
|
|
435
|
-
/**
|
|
436
|
-
* Raised when geolocation is activated and the user's heading changes. Web
|
|
437
|
-
* only.
|
|
438
|
-
*
|
|
439
|
-
* @webOnly
|
|
440
|
-
*/
|
|
441
|
-
get headingChanged(): Event<number>;
|
|
442
|
-
/**
|
|
443
|
-
* Raised when geolocation is activated and a user position has been
|
|
444
|
-
* received.
|
|
445
|
-
*/
|
|
446
|
-
get positionAcquired(): Event<GeolocationEvent>;
|
|
447
|
-
/**
|
|
448
|
-
* Raised when geolocation is activated and the user's position changes.
|
|
449
|
-
*/
|
|
450
|
-
get positionChanged(): Event<Point>;
|
|
451
|
-
/**
|
|
452
|
-
* Raised when geolocation is disabled, either through signal loss or being
|
|
453
|
-
* turned off, and a user position is not available.
|
|
454
|
-
*/
|
|
455
|
-
get positionLost(): Event<GeolocationEvent>;
|
|
456
|
-
/**
|
|
457
|
-
* Raised when the source of geolocation data is changed to a different
|
|
458
|
-
* source (e.g. a GNSS receiver). Mobile only.
|
|
459
|
-
*
|
|
460
|
-
* @mobileOnly
|
|
461
|
-
*/
|
|
462
|
-
get sourceChanged(): Event<GnssDeviceConnectionInfo>;
|
|
463
|
-
/**
|
|
464
|
-
* Raised when geolocation status (enabled or disabled via app permissions)
|
|
465
|
-
* changes.
|
|
466
|
-
*/
|
|
467
|
-
get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
|
|
468
|
-
/**
|
|
469
|
-
* Raised when geolocation enters displaying location mode. Web only.
|
|
470
|
-
*
|
|
471
|
-
* @webOnly
|
|
472
|
-
*/
|
|
473
|
-
get displayLocationStarted(): Event;
|
|
474
|
-
/**
|
|
475
|
-
* Raised when geolocation leaves displaying location mode. Web only.
|
|
476
|
-
*
|
|
477
|
-
* @webOnly
|
|
478
|
-
*/
|
|
479
|
-
get displayLocationStopped(): Event;
|
|
480
|
-
/**
|
|
481
|
-
* Raised when the GNSS transformation is changed. Mobile only.
|
|
482
|
-
*
|
|
483
|
-
* @mobileOnly
|
|
484
|
-
*/
|
|
485
|
-
get transformationChanged(): Event<GnssDeviceTransformationOverrideEventArgs>;
|
|
486
|
-
/**
|
|
487
|
-
* Raised when the GNSS antenna height is changed. Mobile only.
|
|
488
|
-
*
|
|
489
|
-
* @mobileOnly
|
|
490
|
-
*/
|
|
491
|
-
get antennaHeightChanged(): Event<GnssDeviceAntennaHeightEventArgs>;
|
|
492
|
-
/**
|
|
493
|
-
* Raised when the location display mode is changed. Mobile only.
|
|
494
|
-
*
|
|
495
|
-
* @mobileOnly
|
|
496
|
-
*/
|
|
497
|
-
get locationDisplayModeChanged(): Event<LocationDisplayModeChangedEventArgs>;
|
|
498
|
-
}
|
|
499
|
-
export {};
|
|
1
|
+
import type Color from "@arcgis/core/Color";
|
|
2
|
+
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
3
|
+
import type Point from "@arcgis/core/geometry/Point";
|
|
4
|
+
import type SimpleLineSymbol from "@arcgis/core/symbols/SimpleLineSymbol.js";
|
|
5
|
+
import type { SpatialReferenceJson } from "@vertigis/arcgis-extensions/json/SpatialReferenceJson.js";
|
|
6
|
+
import type { ColorJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
|
|
7
|
+
import type { Command } from "../Command.js";
|
|
8
|
+
import { CommandRegistry } from "../CommandRegistry.js";
|
|
9
|
+
import type { TimeSpan } from "../DotNetTypes.js";
|
|
10
|
+
import type { Event } from "../Event.js";
|
|
11
|
+
import { EventRegistry } from "../EventRegistry.js";
|
|
12
|
+
import type { Operation } from "../Operation.js";
|
|
13
|
+
import { OperationRegistry } from "../OperationRegistry.js";
|
|
14
|
+
import type { HasMaps, Maps } from "../common.js";
|
|
15
|
+
import type { CoordinateTransformation } from "./map.js";
|
|
16
|
+
/**
|
|
17
|
+
* Arguments for the "geolocation.accuracy-changed" event.
|
|
18
|
+
*/
|
|
19
|
+
export interface GeolocateAccuracyChangedEventArgs {
|
|
20
|
+
/**
|
|
21
|
+
* The current geolocation accuracy, in meters.
|
|
22
|
+
*/
|
|
23
|
+
accuracy: number;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Arguments for the "geolocation.metadata-changed" event.
|
|
27
|
+
*/
|
|
28
|
+
export interface GeolocateMetadataChangedEventArgs {
|
|
29
|
+
/**
|
|
30
|
+
* The GNSS position metadata.
|
|
31
|
+
*/
|
|
32
|
+
nmeaProperties: NmeaProperties;
|
|
33
|
+
}
|
|
34
|
+
export interface NmeaProperties {
|
|
35
|
+
fixTimeUtc?: Date;
|
|
36
|
+
latitude?: number;
|
|
37
|
+
longitude?: number;
|
|
38
|
+
altitude?: number;
|
|
39
|
+
horizontalDilutionOfPrecision?: number;
|
|
40
|
+
verticalDilutionOfPrecision?: number;
|
|
41
|
+
positionDilutionOfPrecision?: number;
|
|
42
|
+
estimatedVerticalAccuracy?: number;
|
|
43
|
+
preciseVerticalAccuracy?: number;
|
|
44
|
+
estimatedHorizontalAccuracy?: number;
|
|
45
|
+
preciseHorizontalAccuracy?: number;
|
|
46
|
+
satellitesInView?: number;
|
|
47
|
+
satellitesInUse?: number;
|
|
48
|
+
satelliteIds?: number[];
|
|
49
|
+
heightOfGeoid?: number;
|
|
50
|
+
correctionAge?: TimeSpan;
|
|
51
|
+
stationId?: number;
|
|
52
|
+
speed?: number;
|
|
53
|
+
course?: number;
|
|
54
|
+
magneticVariation?: number;
|
|
55
|
+
fixQuality?: FixQuality;
|
|
56
|
+
fixMethod?: string;
|
|
57
|
+
fixMode?: GnssFixMode;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* Current GNSS device settings.
|
|
61
|
+
*/
|
|
62
|
+
export interface GnssDeviceSettings {
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Result for the "geolocation.get-current-state" operation.
|
|
66
|
+
*/
|
|
67
|
+
export interface GeolocateCurrentState {
|
|
68
|
+
/**
|
|
69
|
+
* Whether or not a position is actively being reported and received.
|
|
70
|
+
*/
|
|
71
|
+
isGeolocationAvailable: boolean;
|
|
72
|
+
/**
|
|
73
|
+
* Whether or not the app has been permitted to use geolocation according to
|
|
74
|
+
* the OS level settings.
|
|
75
|
+
*/
|
|
76
|
+
isGeolocationEnabled: boolean;
|
|
77
|
+
/**
|
|
78
|
+
* The current accuracy in meters.
|
|
79
|
+
*/
|
|
80
|
+
accuracy: number;
|
|
81
|
+
/**
|
|
82
|
+
* The current position.
|
|
83
|
+
*/
|
|
84
|
+
position: Point;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Arguments for the "geolocation.status-changed" event.
|
|
88
|
+
*/
|
|
89
|
+
export interface GeolocationStatusChangedEventArgs {
|
|
90
|
+
/**
|
|
91
|
+
* Indicates whether the geolocation is now enabled.
|
|
92
|
+
*/
|
|
93
|
+
isEnabled: boolean;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Arguments for the "geolocation.display-mode-changed" event.
|
|
97
|
+
*/
|
|
98
|
+
export interface LocationDisplayModeChangedEventArgs {
|
|
99
|
+
/**
|
|
100
|
+
* The location display mode.
|
|
101
|
+
*/
|
|
102
|
+
locationDisplayMode: GeolocateState;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* The geolocation state / mode.
|
|
106
|
+
*/
|
|
107
|
+
export type GeolocateState = "Disabled" | "Enabled" | "Recentering" | "RecenteringAndReorienting";
|
|
108
|
+
/**
|
|
109
|
+
* Arguments for geolocation events such as "geolocation.position-acquired" and
|
|
110
|
+
* "geolocation.position-lost".
|
|
111
|
+
*/
|
|
112
|
+
export interface GeolocationEvent {
|
|
113
|
+
/**
|
|
114
|
+
* The GNSS source associated with the raised geolocation event. Mobile
|
|
115
|
+
* only.
|
|
116
|
+
*
|
|
117
|
+
* @mobileOnly
|
|
118
|
+
*/
|
|
119
|
+
gnssDeviceConnectionInfo?: GnssDeviceConnectionInfo;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* A geolocation source.
|
|
123
|
+
*/
|
|
124
|
+
export interface GnssDeviceConnectionInfo {
|
|
125
|
+
/**
|
|
126
|
+
* Name of the GNSS device.
|
|
127
|
+
*/
|
|
128
|
+
deviceName: string;
|
|
129
|
+
/**
|
|
130
|
+
* Full name of the GNSS device.
|
|
131
|
+
*/
|
|
132
|
+
deviceFullName: string;
|
|
133
|
+
/**
|
|
134
|
+
* The type of the device. Options are Integrated, Bluetooth, USB, and
|
|
135
|
+
* Emulator.
|
|
136
|
+
*/
|
|
137
|
+
deviceType: GnssDeviceType;
|
|
138
|
+
/**
|
|
139
|
+
* The device settings, including the correction service's spatial
|
|
140
|
+
* reference, the desired datum transformation, and the device's antenna
|
|
141
|
+
* height.
|
|
142
|
+
*/
|
|
143
|
+
settings: GnssDeviceSettings;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* Arguments for the geolocation.set-location-symbol command.
|
|
147
|
+
*/
|
|
148
|
+
export interface SetLocationSymbolArgs {
|
|
149
|
+
/**
|
|
150
|
+
* The color to use for the location marker's fill and the accuracy circle's
|
|
151
|
+
* outline.
|
|
152
|
+
*/
|
|
153
|
+
color?: Color | ColorJson | string;
|
|
154
|
+
/**
|
|
155
|
+
* The symbol to use for the outline of the location marker.
|
|
156
|
+
*/
|
|
157
|
+
outline?: SimpleLineSymbol;
|
|
158
|
+
/**
|
|
159
|
+
* The size to use for the location marker.
|
|
160
|
+
*/
|
|
161
|
+
size?: number;
|
|
162
|
+
/**
|
|
163
|
+
* The style to use for the location marker. Valid values are: circle,
|
|
164
|
+
* cross, diamond, square, triangle and X.
|
|
165
|
+
*/
|
|
166
|
+
style?: string;
|
|
167
|
+
/**
|
|
168
|
+
* If true, all other properties will be ignored and the location symbol
|
|
169
|
+
* will be reset to the default symbol.
|
|
170
|
+
*/
|
|
171
|
+
default?: boolean;
|
|
172
|
+
}
|
|
173
|
+
type GnssDeviceType = "integrated" | "bluetooth" | "usb" | "emulator";
|
|
174
|
+
/**
|
|
175
|
+
* Arguments for getting a list of geographic transformations.
|
|
176
|
+
*/
|
|
177
|
+
export interface GetTransformationArgs {
|
|
178
|
+
/**
|
|
179
|
+
* The input spatial reference to transform. For example, the spatial
|
|
180
|
+
* reference of a GNSS receiver. If unspecified, defaults to WGS84.
|
|
181
|
+
*/
|
|
182
|
+
inputSpatialReference?: SpatialReferenceJson;
|
|
183
|
+
/**
|
|
184
|
+
* The desired output spatial reference of the transformations. For example,
|
|
185
|
+
* the spatial reference of the map. If unspecified, the spatial reference
|
|
186
|
+
* of the first available map will be used.
|
|
187
|
+
*/
|
|
188
|
+
outputSpatialReference?: SpatialReferenceJson;
|
|
189
|
+
/**
|
|
190
|
+
* The area of interest. If provided, this will be used to order the list of
|
|
191
|
+
* valid transformations in order of best-fit.
|
|
192
|
+
*/
|
|
193
|
+
area?: Geometry;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Event args for the geolocation.gnss-lock-status-changed event.
|
|
197
|
+
*/
|
|
198
|
+
export interface GnssLockStateEventArgs {
|
|
199
|
+
/**
|
|
200
|
+
* The lock status.
|
|
201
|
+
*/
|
|
202
|
+
lockStatus: GnssLockStatus;
|
|
203
|
+
}
|
|
204
|
+
/**
|
|
205
|
+
* Event args for the geolocation.gnss-transformation-changed event.
|
|
206
|
+
*/
|
|
207
|
+
export interface GnssDeviceTransformationOverrideEventArgs {
|
|
208
|
+
/**
|
|
209
|
+
* The WKID of the transformation.
|
|
210
|
+
*/
|
|
211
|
+
wkid: number;
|
|
212
|
+
/**
|
|
213
|
+
* The data transformation name.
|
|
214
|
+
*/
|
|
215
|
+
name: string;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* The quality of the GNSS fix.
|
|
219
|
+
*/
|
|
220
|
+
export type FixQuality = "Invalid" | "GpsFix" | "DgpsFix" | "PpsFix" | "Rtk" | "FloatRtk" | "Estimated" | "ManualInput" | "Simulation";
|
|
221
|
+
/**
|
|
222
|
+
* The GNSS fix mode.
|
|
223
|
+
*/
|
|
224
|
+
export interface GnssFixMode {
|
|
225
|
+
/**
|
|
226
|
+
* The GPGSA fix mode.
|
|
227
|
+
*/
|
|
228
|
+
mode: GpgsaFixMode;
|
|
229
|
+
/**
|
|
230
|
+
* The display text.
|
|
231
|
+
*/
|
|
232
|
+
displayText: string;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Global Positioning Global navigation satellite System Agency fix mode.
|
|
236
|
+
*/
|
|
237
|
+
export type GpgsaFixMode = "NotAvailable" | "Fix2D" | "Fix3";
|
|
238
|
+
/**
|
|
239
|
+
* GNSS lock status.
|
|
240
|
+
*/
|
|
241
|
+
export type GnssLockStatus =
|
|
242
|
+
/**
|
|
243
|
+
* Good.
|
|
244
|
+
*/
|
|
245
|
+
0
|
|
246
|
+
/**
|
|
247
|
+
* UncorrectedPosition.
|
|
248
|
+
*/
|
|
249
|
+
| 1
|
|
250
|
+
/**
|
|
251
|
+
* EstimatedAccuracy.
|
|
252
|
+
*/
|
|
253
|
+
| 2
|
|
254
|
+
/**
|
|
255
|
+
* LostConnection.
|
|
256
|
+
*/
|
|
257
|
+
| 4
|
|
258
|
+
/**
|
|
259
|
+
* NoLocation.
|
|
260
|
+
*/
|
|
261
|
+
| 16
|
|
262
|
+
/**
|
|
263
|
+
* Integrated.
|
|
264
|
+
*/
|
|
265
|
+
| 32;
|
|
266
|
+
/**
|
|
267
|
+
* Event args for the geolocation.gnss-antenna-height-changed event.
|
|
268
|
+
*/
|
|
269
|
+
export interface GnssDeviceAntennaHeightEventArgs {
|
|
270
|
+
/**
|
|
271
|
+
* The antenna height.
|
|
272
|
+
*/
|
|
273
|
+
height: number;
|
|
274
|
+
}
|
|
275
|
+
export declare class GeolocationCommands extends CommandRegistry {
|
|
276
|
+
protected readonly _prefix = "geolocation";
|
|
277
|
+
/**
|
|
278
|
+
* Centers the map on the user's current location and keeps the location
|
|
279
|
+
* centered as it moves around. The maps parameter is only supported in
|
|
280
|
+
* VertiGIS Studio Mobile. In VertiGIS Studio Web, all maps are affected.
|
|
281
|
+
*/
|
|
282
|
+
get autoRecenter(): Command<Maps | void>;
|
|
283
|
+
/**
|
|
284
|
+
* Centers the map on the user's current location and updates the
|
|
285
|
+
* orientation of the map to face the direction of the device. Keeps the
|
|
286
|
+
* location centered as it moves around. Returns whether guiding started
|
|
287
|
+
* successfully. Mobile only.
|
|
288
|
+
*
|
|
289
|
+
* @mobileOnly
|
|
290
|
+
*/
|
|
291
|
+
get autoRecenterAndReorient(): Command<HasMaps>;
|
|
292
|
+
/**
|
|
293
|
+
* Show the user's location while the location is in the map's extent.
|
|
294
|
+
*/
|
|
295
|
+
get displayLocation(): Command;
|
|
296
|
+
/**
|
|
297
|
+
* Turns off geolocation.
|
|
298
|
+
*/
|
|
299
|
+
get turnOffGeolocation(): Command;
|
|
300
|
+
/**
|
|
301
|
+
* Displays the GNSS device settings view. Mobile only.
|
|
302
|
+
*
|
|
303
|
+
* @mobileOnly
|
|
304
|
+
*/
|
|
305
|
+
get displayDeviceSettings(): Command<GnssDeviceConnectionInfo>;
|
|
306
|
+
/**
|
|
307
|
+
* Displays the GNSS device metadata view. Mobile only.
|
|
308
|
+
*
|
|
309
|
+
* @mobileOnly
|
|
310
|
+
*/
|
|
311
|
+
get displayDeviceMetadata(): Command;
|
|
312
|
+
/**
|
|
313
|
+
* Displays the GNSS device selection view. Mobile only.
|
|
314
|
+
*
|
|
315
|
+
* @mobileOnly
|
|
316
|
+
*/
|
|
317
|
+
get displayDeviceSelection(): Command;
|
|
318
|
+
/**
|
|
319
|
+
* Applies a datum transformation to the current GNSS device. Mobile only.
|
|
320
|
+
*
|
|
321
|
+
* @mobileOnly
|
|
322
|
+
*/
|
|
323
|
+
get applyDatumTransformation(): Command<CoordinateTransformation | string | number | number[]>;
|
|
324
|
+
/**
|
|
325
|
+
* Modifies the location display symbol. Mobile only.
|
|
326
|
+
*
|
|
327
|
+
* @mobileOnly
|
|
328
|
+
*/
|
|
329
|
+
get setLocationSymbol(): Command<SetLocationSymbolArgs>;
|
|
330
|
+
}
|
|
331
|
+
export declare class GeolocationOperations extends OperationRegistry {
|
|
332
|
+
protected readonly _prefix = "geolocation";
|
|
333
|
+
/**
|
|
334
|
+
* Updates the currently active GNSS receiver. Mobile only.
|
|
335
|
+
*
|
|
336
|
+
* @mobileOnly
|
|
337
|
+
*/
|
|
338
|
+
get changeSource(): Operation<GnssDeviceConnectionInfo, void>;
|
|
339
|
+
/**
|
|
340
|
+
* Gets the currently active geolocation source. Mobile only.
|
|
341
|
+
*
|
|
342
|
+
* @mobileOnly
|
|
343
|
+
*/
|
|
344
|
+
get getActiveSource(): Operation<GnssDeviceConnectionInfo>;
|
|
345
|
+
/**
|
|
346
|
+
* Gets the list of currently available geolocation sources. Includes
|
|
347
|
+
* integrated receivers, GNSS devices, and emulators. Mobile only.
|
|
348
|
+
*
|
|
349
|
+
* @mobileOnly
|
|
350
|
+
*/
|
|
351
|
+
get getAllSources(): Operation<boolean, GnssDeviceConnectionInfo[]>;
|
|
352
|
+
/**
|
|
353
|
+
* Gets the current geolocate state.
|
|
354
|
+
*/
|
|
355
|
+
get getCurrentState(): Operation<void, GeolocateCurrentState>;
|
|
356
|
+
/**
|
|
357
|
+
* Returns whether integrated location services have been permitted via app
|
|
358
|
+
* or browser permissions.
|
|
359
|
+
*/
|
|
360
|
+
get getLocationPermissionsEnabled(): Operation<boolean>;
|
|
361
|
+
/**
|
|
362
|
+
* Returns the current user position. This Operation can block while the
|
|
363
|
+
* user is prompted for permission, as such it is considered best practice
|
|
364
|
+
* not to perform this during startup.
|
|
365
|
+
*/
|
|
366
|
+
get getPosition(): Operation<void, Point>;
|
|
367
|
+
/**
|
|
368
|
+
* Returns a list of valid coordinate transformations for given input and
|
|
369
|
+
* output spatial references. Mobile only.
|
|
370
|
+
*
|
|
371
|
+
* @mobileOnly
|
|
372
|
+
*/
|
|
373
|
+
get getCoordinateTransformations(): Operation<GetTransformationArgs, CoordinateTransformation[]>;
|
|
374
|
+
}
|
|
375
|
+
export declare class GeolocationEvents extends EventRegistry {
|
|
376
|
+
protected readonly _prefix = "geolocation";
|
|
377
|
+
/**
|
|
378
|
+
* Raised when geolocation is activated and the accuracy of geolocation
|
|
379
|
+
* changes.
|
|
380
|
+
*/
|
|
381
|
+
get accuracyChanged(): Event<GeolocateAccuracyChangedEventArgs>;
|
|
382
|
+
/**
|
|
383
|
+
* Raised when a GNSS receiver is active and metadata about the device or
|
|
384
|
+
* location change. Mobile only.
|
|
385
|
+
*
|
|
386
|
+
* @mobileOnly
|
|
387
|
+
*/
|
|
388
|
+
get metadataChanged(): Event<GeolocateMetadataChangedEventArgs>;
|
|
389
|
+
/**
|
|
390
|
+
* Raised when geolocation enters auto recenter mode. For VertiGIS Studio
|
|
391
|
+
* Web Viewer, the event will have no parameter (all maps are always
|
|
392
|
+
* affected).
|
|
393
|
+
*/
|
|
394
|
+
get autoRecenterStarted(): Event<HasMaps | void>;
|
|
395
|
+
/**
|
|
396
|
+
* Raised when the user changes the geolocation mode to
|
|
397
|
+
* recenter-and-reorient (updates map orientation to match device
|
|
398
|
+
* direction). Mobile only.
|
|
399
|
+
*
|
|
400
|
+
* @mobileOnly
|
|
401
|
+
*/
|
|
402
|
+
get autoRecenterAndReorientStarted(): Event<HasMaps>;
|
|
403
|
+
/**
|
|
404
|
+
* Raised when geolocation leaves auto recenter mode. For VertiGIS Studio
|
|
405
|
+
* Web Viewer, the event will have no parameter (all maps are always
|
|
406
|
+
* affected).
|
|
407
|
+
*/
|
|
408
|
+
get autoRecenterStopped(): Event<HasMaps | void>;
|
|
409
|
+
/**
|
|
410
|
+
* Raised when the user changes the geolocation mode to not
|
|
411
|
+
* recenter-and-reorient. Mobile only.
|
|
412
|
+
*
|
|
413
|
+
* @mobileOnly
|
|
414
|
+
*/
|
|
415
|
+
get autoRecenterAndReorientStopped(): Event<HasMaps>;
|
|
416
|
+
/**
|
|
417
|
+
* Raised when detection of connected GNSS receivers begins. Mobile only.
|
|
418
|
+
*
|
|
419
|
+
* @mobileOnly
|
|
420
|
+
*/
|
|
421
|
+
get gnssDeviceDetectionStarted(): Event;
|
|
422
|
+
/**
|
|
423
|
+
* Raised when detection of connected GNSS receivers ends. Mobile only.
|
|
424
|
+
*
|
|
425
|
+
* @mobileOnly
|
|
426
|
+
*/
|
|
427
|
+
get gnssDeviceDetectionStopped(): Event;
|
|
428
|
+
/**
|
|
429
|
+
* Raised when the lock status of an active GNSS device changes. Mobile
|
|
430
|
+
* only.
|
|
431
|
+
*
|
|
432
|
+
* @mobileOnly
|
|
433
|
+
*/
|
|
434
|
+
get gnssLockStatusChanged(): Event<GnssLockStateEventArgs>;
|
|
435
|
+
/**
|
|
436
|
+
* Raised when geolocation is activated and the user's heading changes. Web
|
|
437
|
+
* only.
|
|
438
|
+
*
|
|
439
|
+
* @webOnly
|
|
440
|
+
*/
|
|
441
|
+
get headingChanged(): Event<number>;
|
|
442
|
+
/**
|
|
443
|
+
* Raised when geolocation is activated and a user position has been
|
|
444
|
+
* received.
|
|
445
|
+
*/
|
|
446
|
+
get positionAcquired(): Event<GeolocationEvent>;
|
|
447
|
+
/**
|
|
448
|
+
* Raised when geolocation is activated and the user's position changes.
|
|
449
|
+
*/
|
|
450
|
+
get positionChanged(): Event<Point>;
|
|
451
|
+
/**
|
|
452
|
+
* Raised when geolocation is disabled, either through signal loss or being
|
|
453
|
+
* turned off, and a user position is not available.
|
|
454
|
+
*/
|
|
455
|
+
get positionLost(): Event<GeolocationEvent>;
|
|
456
|
+
/**
|
|
457
|
+
* Raised when the source of geolocation data is changed to a different
|
|
458
|
+
* source (e.g. a GNSS receiver). Mobile only.
|
|
459
|
+
*
|
|
460
|
+
* @mobileOnly
|
|
461
|
+
*/
|
|
462
|
+
get sourceChanged(): Event<GnssDeviceConnectionInfo>;
|
|
463
|
+
/**
|
|
464
|
+
* Raised when geolocation status (enabled or disabled via app permissions)
|
|
465
|
+
* changes.
|
|
466
|
+
*/
|
|
467
|
+
get statusChanged(): Event<GeolocationStatusChangedEventArgs>;
|
|
468
|
+
/**
|
|
469
|
+
* Raised when geolocation enters displaying location mode. Web only.
|
|
470
|
+
*
|
|
471
|
+
* @webOnly
|
|
472
|
+
*/
|
|
473
|
+
get displayLocationStarted(): Event;
|
|
474
|
+
/**
|
|
475
|
+
* Raised when geolocation leaves displaying location mode. Web only.
|
|
476
|
+
*
|
|
477
|
+
* @webOnly
|
|
478
|
+
*/
|
|
479
|
+
get displayLocationStopped(): Event;
|
|
480
|
+
/**
|
|
481
|
+
* Raised when the GNSS transformation is changed. Mobile only.
|
|
482
|
+
*
|
|
483
|
+
* @mobileOnly
|
|
484
|
+
*/
|
|
485
|
+
get transformationChanged(): Event<GnssDeviceTransformationOverrideEventArgs>;
|
|
486
|
+
/**
|
|
487
|
+
* Raised when the GNSS antenna height is changed. Mobile only.
|
|
488
|
+
*
|
|
489
|
+
* @mobileOnly
|
|
490
|
+
*/
|
|
491
|
+
get antennaHeightChanged(): Event<GnssDeviceAntennaHeightEventArgs>;
|
|
492
|
+
/**
|
|
493
|
+
* Raised when the location display mode is changed. Mobile only.
|
|
494
|
+
*
|
|
495
|
+
* @mobileOnly
|
|
496
|
+
*/
|
|
497
|
+
get locationDisplayModeChanged(): Event<LocationDisplayModeChangedEventArgs>;
|
|
498
|
+
}
|
|
499
|
+
export {};
|