@vertigis/viewer-spec 56.23.0 → 56.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +87 -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/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/layout/schema/layout-common.xsd +20 -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 +960 -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 +8397 -23281
- 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,1275 +1,1275 @@
|
|
|
1
|
-
import type Graphic from "@arcgis/core/Graphic.js";
|
|
2
|
-
import type EsriMap from "@arcgis/core/Map";
|
|
3
|
-
import type Viewpoint from "@arcgis/core/Viewpoint";
|
|
4
|
-
import type Extent from "@arcgis/core/geometry/Extent";
|
|
5
|
-
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
6
|
-
import type Point from "@arcgis/core/geometry/Point";
|
|
7
|
-
import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
|
|
8
|
-
import type GeographicTransformation from "@arcgis/core/geometry/support/GeographicTransformation";
|
|
9
|
-
import type Layer from "@arcgis/core/layers/Layer";
|
|
10
|
-
import type { GeometryJsonType } from "@vertigis/arcgis-extensions/json/GeometryJson.js";
|
|
11
|
-
import type { OperationalLayerJson } from "@vertigis/arcgis-extensions/json/OperationalLayerJson.js";
|
|
12
|
-
import type { SymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
|
|
13
|
-
import type { LayerPreset } from "@vertigis/arcgis-extensions/layer-preset/LayerPreset";
|
|
14
|
-
import type { LayerExtension } from "@vertigis/arcgis-extensions/mapping/LayerExtension";
|
|
15
|
-
import type { MapExtension, ViewMode } from "@vertigis/arcgis-extensions/mapping/MapExtension";
|
|
16
|
-
import type { Action } from "@vertigis/arcgis-extensions/support/Action";
|
|
17
|
-
import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
|
|
18
|
-
import type { Command } from "../Command.js";
|
|
19
|
-
import { CommandRegistry } from "../CommandRegistry.js";
|
|
20
|
-
import type { TimeSpan } from "../DotNetTypes.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 { Features, FeaturesLike, Geometries, GeometryLike, GraphicsLike, HasMaps, HasUITarget, Layers, LayersLike, Maps, MapsLike, ViewpointLike } from "../common.js";
|
|
26
|
-
import type { EnhancedFileData } from "./file.js";
|
|
27
|
-
import type { PortalItemData } from "./portal.js";
|
|
28
|
-
import type { GeometryEditorSettings } from "./sketching.js";
|
|
29
|
-
/**
|
|
30
|
-
* Levels (z-orders) to which markup can be assigned, listed from high to low.
|
|
31
|
-
*/
|
|
32
|
-
export type MarkupLevel = "ui" | "labels" | "custom3" | "custom2" | "custom1" | "default";
|
|
33
|
-
/**
|
|
34
|
-
* Arguments for the various map events.
|
|
35
|
-
*/
|
|
36
|
-
export interface MapEvent {
|
|
37
|
-
/**
|
|
38
|
-
* The map from which the event was generated. Web only.
|
|
39
|
-
*
|
|
40
|
-
* @webOnly
|
|
41
|
-
*/
|
|
42
|
-
maps?: MapsLike;
|
|
43
|
-
/**
|
|
44
|
-
* The map extension for which the event was generated. This property is
|
|
45
|
-
* required in VertiGIS Studio Mobile. Mobile only.
|
|
46
|
-
*
|
|
47
|
-
* @mobileOnly
|
|
48
|
-
*/
|
|
49
|
-
mapExtension?: MapExtension;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Arguments for the ViewModeChanged event.
|
|
53
|
-
*/
|
|
54
|
-
export interface ViewModeChangedEvent extends MapEvent {
|
|
55
|
-
/**
|
|
56
|
-
* The new ViewMode.
|
|
57
|
-
*/
|
|
58
|
-
viewMode?: ViewMode;
|
|
59
|
-
}
|
|
60
|
-
/**
|
|
61
|
-
* Arguments for the map.zoom-to-viewpoint command.
|
|
62
|
-
*/
|
|
63
|
-
export interface ZoomToViewpointArgs {
|
|
64
|
-
/**
|
|
65
|
-
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
66
|
-
*/
|
|
67
|
-
maps?: MapsLike;
|
|
68
|
-
/**
|
|
69
|
-
* The viewpoint to zoom to.
|
|
70
|
-
*/
|
|
71
|
-
viewpoint: ViewpointLike | string;
|
|
72
|
-
}
|
|
73
|
-
/**
|
|
74
|
-
* The result of getting a Viewpoint.
|
|
75
|
-
*/
|
|
76
|
-
export interface GetViewpointResult {
|
|
77
|
-
/**
|
|
78
|
-
* The map(s) used in the operation.
|
|
79
|
-
*/
|
|
80
|
-
maps?: MapsLike;
|
|
81
|
-
/**
|
|
82
|
-
* The viewpoint.
|
|
83
|
-
*/
|
|
84
|
-
viewpoint: Viewpoint;
|
|
85
|
-
}
|
|
86
|
-
/**
|
|
87
|
-
* Arguments for the map.zoom-to-layer-extent and
|
|
88
|
-
* map.zoom-to-layer-visible-scale commands.
|
|
89
|
-
*/
|
|
90
|
-
export interface ZoomToLayerArgs {
|
|
91
|
-
/**
|
|
92
|
-
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
93
|
-
*/
|
|
94
|
-
maps?: MapsLike;
|
|
95
|
-
/**
|
|
96
|
-
* The layer(s) to zoom to.
|
|
97
|
-
*/
|
|
98
|
-
layers: LayersLike;
|
|
99
|
-
}
|
|
100
|
-
/**
|
|
101
|
-
* Arguments for the map.zoom-to-scale command.
|
|
102
|
-
*/
|
|
103
|
-
export interface ZoomToScaleArgs {
|
|
104
|
-
/**
|
|
105
|
-
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
106
|
-
*/
|
|
107
|
-
maps?: MapsLike;
|
|
108
|
-
/**
|
|
109
|
-
* The scale to zoom to.
|
|
110
|
-
*/
|
|
111
|
-
scale: number;
|
|
112
|
-
}
|
|
113
|
-
/**
|
|
114
|
-
* Arguments for the map.zoom-to-features command.
|
|
115
|
-
*/
|
|
116
|
-
export interface ZoomToFeaturesArgs {
|
|
117
|
-
/**
|
|
118
|
-
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
119
|
-
*/
|
|
120
|
-
maps?: MapsLike;
|
|
121
|
-
/**
|
|
122
|
-
* The feature(s) to zoom to.
|
|
123
|
-
*/
|
|
124
|
-
features: FeaturesLike;
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* Arguments for the "map.get-extent" operation.
|
|
128
|
-
*/
|
|
129
|
-
export interface GetExtentArgs {
|
|
130
|
-
/**
|
|
131
|
-
* The map from which to retrieve the extent.
|
|
132
|
-
*/
|
|
133
|
-
maps?: MapsLike;
|
|
134
|
-
}
|
|
135
|
-
/**
|
|
136
|
-
* Result of the "map.get-extent" operation.
|
|
137
|
-
*/
|
|
138
|
-
export interface GetExtentResult {
|
|
139
|
-
/**
|
|
140
|
-
* The extent for the selected map.
|
|
141
|
-
*/
|
|
142
|
-
geometry: Geometry;
|
|
143
|
-
/**
|
|
144
|
-
* The associated map for the retrieved extent.
|
|
145
|
-
*/
|
|
146
|
-
maps: MapsLike;
|
|
147
|
-
}
|
|
148
|
-
/**
|
|
149
|
-
* Base arguments for markup commands and operations.
|
|
150
|
-
*/
|
|
151
|
-
export interface MarkupArgs extends HasMaps {
|
|
152
|
-
/**
|
|
153
|
-
* The named collection of markup to operate on. If not specified the
|
|
154
|
-
* default markup collection will be used. Some markup collection names are
|
|
155
|
-
* used internally by Web:
|
|
156
|
-
*
|
|
157
|
-
* "default": The default markup layer.
|
|
158
|
-
*
|
|
159
|
-
* "vgs-active-snapping-guides": The active snap point when snapping.
|
|
160
|
-
*
|
|
161
|
-
* "vgs-buffer": Buffer graphics from out of the box buffer tools.
|
|
162
|
-
*
|
|
163
|
-
* "vgs-context-marker": Right click context marker on map.
|
|
164
|
-
*
|
|
165
|
-
* "vgs-dirty-indicator": Invalid geometry indicators used when editing.
|
|
166
|
-
*
|
|
167
|
-
* "vgs-editing-control": Edit frame and vertices while editing geometries.
|
|
168
|
-
*
|
|
169
|
-
* "vgs-location-accuracy": Location accuracy circle when geolocating.
|
|
170
|
-
*
|
|
171
|
-
* "vgs-location-marker-*": Location markers have this prefix followed by
|
|
172
|
-
* the marker id.
|
|
173
|
-
*
|
|
174
|
-
* "vgs-map-notes": Map Notes.
|
|
175
|
-
*
|
|
176
|
-
* "vgs-measurement-labels": Labels on measured graphics.
|
|
177
|
-
*
|
|
178
|
-
* "vgs-other-snapping-guides": Additional snapping point visualizations.
|
|
179
|
-
*
|
|
180
|
-
* "vgs-query": Graphics representing the custom spatial filter for the
|
|
181
|
-
* query builder tool.
|
|
182
|
-
*
|
|
183
|
-
* "vgs-self-snaps": Used internally by snapping.
|
|
184
|
-
*
|
|
185
|
-
* "vgs-sketching": Temporary graphics used while drawing geometries.
|
|
186
|
-
*
|
|
187
|
-
* "vgs-snapping-radius": Snapping radius when snapping is active.
|
|
188
|
-
*
|
|
189
|
-
* "vgs-transient-measurement-labels": Measurement labels used while
|
|
190
|
-
* drawing.
|
|
191
|
-
*
|
|
192
|
-
* Web only.
|
|
193
|
-
*
|
|
194
|
-
* @webOnly
|
|
195
|
-
*/
|
|
196
|
-
collection?: string;
|
|
197
|
-
}
|
|
198
|
-
/**
|
|
199
|
-
* Arguments for the "map.add-markup" command.
|
|
200
|
-
*/
|
|
201
|
-
export interface AddMarkupArgs extends MarkupArgs {
|
|
202
|
-
/**
|
|
203
|
-
* The markup to add to the map. `GraphicsLike` is only available in Web.
|
|
204
|
-
*/
|
|
205
|
-
graphics?: Graphic[] | GraphicsLike;
|
|
206
|
-
/**
|
|
207
|
-
* The level (z-order) to assign the markup to. If not specified uses the
|
|
208
|
-
* same level as default markup. Web only.
|
|
209
|
-
*
|
|
210
|
-
* @webOnly
|
|
211
|
-
*/
|
|
212
|
-
level?: MarkupLevel;
|
|
213
|
-
}
|
|
214
|
-
/**
|
|
215
|
-
* Arguments for the "map.clear-markup" command.
|
|
216
|
-
*
|
|
217
|
-
* @webOnly
|
|
218
|
-
*/
|
|
219
|
-
export interface ClearMarkupArgs extends MarkupArgs {
|
|
220
|
-
/**
|
|
221
|
-
* The markup to clear. If not specified will clear all markup in the
|
|
222
|
-
* selected collection.
|
|
223
|
-
*/
|
|
224
|
-
graphics?: GraphicsLike;
|
|
225
|
-
}
|
|
226
|
-
/**
|
|
227
|
-
* Arguments for the "map.get-markup" operation.
|
|
228
|
-
*/
|
|
229
|
-
export interface GetMarkupArgs extends MarkupArgs {
|
|
230
|
-
/**
|
|
231
|
-
* The geometry used to bound the retrieved markup. If not specified all
|
|
232
|
-
* markup in the selected collection will be returned.
|
|
233
|
-
*/
|
|
234
|
-
geometry?: Geometry;
|
|
235
|
-
}
|
|
236
|
-
/**
|
|
237
|
-
* Result of the "map.get-markup" operation.
|
|
238
|
-
*/
|
|
239
|
-
export interface GetMarkupResult {
|
|
240
|
-
/**
|
|
241
|
-
* The markup results.
|
|
242
|
-
*/
|
|
243
|
-
graphics: GraphicsLike;
|
|
244
|
-
/**
|
|
245
|
-
* The associated map the markup was retrieved from.
|
|
246
|
-
*/
|
|
247
|
-
maps?: MapsLike;
|
|
248
|
-
}
|
|
249
|
-
/**
|
|
250
|
-
* Represents an operational layer.
|
|
251
|
-
*/
|
|
252
|
-
export type OperationalLayerLike = Layer | OperationalLayerJson | LayerExtension | PortalItemLike;
|
|
253
|
-
/**
|
|
254
|
-
* Arguments for the map.add-layers command.
|
|
255
|
-
*/
|
|
256
|
-
export interface AddLayersArgs {
|
|
257
|
-
/**
|
|
258
|
-
* The layer(s) to add.
|
|
259
|
-
*/
|
|
260
|
-
layers: OperationalLayerLike | OperationalLayerLike[];
|
|
261
|
-
/**
|
|
262
|
-
* The associated map(s) for the layer(s).
|
|
263
|
-
*/
|
|
264
|
-
maps?: MapsLike;
|
|
265
|
-
}
|
|
266
|
-
/**
|
|
267
|
-
* Arguments for the map.remove-layers command.
|
|
268
|
-
*/
|
|
269
|
-
export interface RemoveLayersArgs {
|
|
270
|
-
/**
|
|
271
|
-
* The layer(s) to remove.
|
|
272
|
-
*/
|
|
273
|
-
layers: LayersLike;
|
|
274
|
-
/**
|
|
275
|
-
* The associated map(s) for the layer(s).
|
|
276
|
-
*/
|
|
277
|
-
maps?: MapsLike;
|
|
278
|
-
}
|
|
279
|
-
/**
|
|
280
|
-
* Arguments for the map.apply-layer-preset command.
|
|
281
|
-
*/
|
|
282
|
-
export interface ApplyLayerPresetArgs {
|
|
283
|
-
/**
|
|
284
|
-
* The map(s) to which the layerPreset will be applied.
|
|
285
|
-
*/
|
|
286
|
-
maps?: MapsLike;
|
|
287
|
-
/**
|
|
288
|
-
* The LayerPreset to apply.
|
|
289
|
-
*/
|
|
290
|
-
layerPreset: LayerPreset;
|
|
291
|
-
}
|
|
292
|
-
/**
|
|
293
|
-
* Arguments for the map.update-layer command.
|
|
294
|
-
*/
|
|
295
|
-
export interface UpdateLayerArgs {
|
|
296
|
-
/**
|
|
297
|
-
* The associated map(s) for the layer(s).
|
|
298
|
-
*/
|
|
299
|
-
maps?: MapsLike;
|
|
300
|
-
/**
|
|
301
|
-
* The web map spec JSON used to update the Layer.
|
|
302
|
-
*/
|
|
303
|
-
layerJson: OperationalLayerJson;
|
|
304
|
-
/**
|
|
305
|
-
* The layer to update. If more than one layer is present, only the first
|
|
306
|
-
* will be updated and the rest will be ignored.
|
|
307
|
-
*/
|
|
308
|
-
layers: LayersLike;
|
|
309
|
-
}
|
|
310
|
-
/**
|
|
311
|
-
* Arguments for the map.create-note command.
|
|
312
|
-
*/
|
|
313
|
-
export interface CreateMapNoteArgs extends HasUITarget {
|
|
314
|
-
/**
|
|
315
|
-
* Optionally the features that can be referenced for inserting snippets.
|
|
316
|
-
*/
|
|
317
|
-
features?: FeaturesLike;
|
|
318
|
-
/**
|
|
319
|
-
* The map that should show the created note.
|
|
320
|
-
*/
|
|
321
|
-
maps?: MapsLike;
|
|
322
|
-
/**
|
|
323
|
-
* The location for the map note.
|
|
324
|
-
*/
|
|
325
|
-
geometry: Point;
|
|
326
|
-
}
|
|
327
|
-
/**
|
|
328
|
-
* Arguments for the map.edit-note command.
|
|
329
|
-
*/
|
|
330
|
-
export interface EditMapNotesArgs extends HasUITarget {
|
|
331
|
-
/**
|
|
332
|
-
* Optionally the features that can be referenced for inserting snippets.
|
|
333
|
-
*/
|
|
334
|
-
features?: FeaturesLike;
|
|
335
|
-
/**
|
|
336
|
-
* The map on which to edit the result.
|
|
337
|
-
*/
|
|
338
|
-
maps: MapsLike;
|
|
339
|
-
/**
|
|
340
|
-
* The geometry from which to attempt to select the Note.
|
|
341
|
-
*/
|
|
342
|
-
geometry?: Point;
|
|
343
|
-
}
|
|
344
|
-
/**
|
|
345
|
-
* Arguments for the map.get-user-coordinates-input operation.
|
|
346
|
-
*/
|
|
347
|
-
export interface GetCoordinateArgs extends HasUITarget {
|
|
348
|
-
/**
|
|
349
|
-
* The map on which to select the result.
|
|
350
|
-
*/
|
|
351
|
-
maps?: MapsLike;
|
|
352
|
-
/**
|
|
353
|
-
* Indicates if the user should be given the option to select a point from
|
|
354
|
-
* the map.
|
|
355
|
-
*/
|
|
356
|
-
allowSelectFromMap?: boolean;
|
|
357
|
-
/**
|
|
358
|
-
* An optional starting coordinate.
|
|
359
|
-
*/
|
|
360
|
-
geometry?: Point;
|
|
361
|
-
/**
|
|
362
|
-
* Optionally override the display text on the complete button. Defaults to
|
|
363
|
-
* 'OK'.
|
|
364
|
-
*/
|
|
365
|
-
completeLabel?: string;
|
|
366
|
-
}
|
|
367
|
-
/**
|
|
368
|
-
* The result of a map.get-user-coordinates-input operation.
|
|
369
|
-
*/
|
|
370
|
-
export interface GetCoordinateResult {
|
|
371
|
-
/**
|
|
372
|
-
* The result.
|
|
373
|
-
*/
|
|
374
|
-
geometry: Point;
|
|
375
|
-
/**
|
|
376
|
-
* The associated map.
|
|
377
|
-
*/
|
|
378
|
-
maps: MapsLike;
|
|
379
|
-
}
|
|
380
|
-
/**
|
|
381
|
-
* The unit for calculating the buffer distance when 'distance' is specified for
|
|
382
|
-
* a filter effect.
|
|
383
|
-
*/
|
|
384
|
-
export type FilterDistanceUnits = "feet" | "miles" | "nautical-miles" | "meters" | "kilometers";
|
|
385
|
-
/**
|
|
386
|
-
* The spatial relationship for a filter effect.
|
|
387
|
-
*/
|
|
388
|
-
export type FilterSpatialRelationship = "contains" | "crosses" | "envelope-intersects" | "overlaps" | "touches" | "within" | "disjoint" | "intersects";
|
|
389
|
-
/**
|
|
390
|
-
* A time extent for a filter effect.
|
|
391
|
-
*/
|
|
392
|
-
export interface TimeExtent {
|
|
393
|
-
/**
|
|
394
|
-
* The beginning of the time interval, as either a JavaScript Date object or
|
|
395
|
-
* the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
|
|
396
|
-
*/
|
|
397
|
-
start: Date | number;
|
|
398
|
-
/**
|
|
399
|
-
* The end of the time interval, as either a JavaScript Date object or the
|
|
400
|
-
* number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
|
|
401
|
-
*/
|
|
402
|
-
end: Date | number;
|
|
403
|
-
}
|
|
404
|
-
/**
|
|
405
|
-
* Filter effect configuration for either the included or excluded filter.
|
|
406
|
-
*/
|
|
407
|
-
export interface FilterEffectSettings {
|
|
408
|
-
/**
|
|
409
|
-
* Converts the input image to grayscale. The value defines the proportion
|
|
410
|
-
* of the conversion. A value of 100% (or 1) is completely grayscale. A
|
|
411
|
-
* value of 0% (or 0) leaves the input unchanged. See
|
|
412
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/grayscale
|
|
413
|
-
* for more details.
|
|
414
|
-
*/
|
|
415
|
-
grayscale?: string;
|
|
416
|
-
/**
|
|
417
|
-
* Converts the input image to sepia. The value defines the proportion of
|
|
418
|
-
* the conversion. A value of 100% (or 1) is completely grayscale. A value
|
|
419
|
-
* of 0% (or 0) leaves the input unchanged. See
|
|
420
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/sepia
|
|
421
|
-
* for more details.
|
|
422
|
-
*/
|
|
423
|
-
sepia?: string;
|
|
424
|
-
/**
|
|
425
|
-
* Applies a hue rotation on the input image. The value defines the number
|
|
426
|
-
* of degrees around the color circle the input samples will be adjusted. A
|
|
427
|
-
* value of 0deg leaves the input unchanged. There is no maximum value; the
|
|
428
|
-
* effect of values above 360deg wraps around. See
|
|
429
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/hue-rotate
|
|
430
|
-
* for more details.
|
|
431
|
-
*/
|
|
432
|
-
hueRotate?: string;
|
|
433
|
-
/**
|
|
434
|
-
* Inverts the samples in the input image. The value defines the proportion
|
|
435
|
-
* of the conversion. A value of 100% (or 1) is completely inverted. A value
|
|
436
|
-
* of 0% (or 0) leaves the input unchanged. See
|
|
437
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/invert
|
|
438
|
-
* for more details.
|
|
439
|
-
*/
|
|
440
|
-
invert?: string;
|
|
441
|
-
/**
|
|
442
|
-
* Applies transparency to the samples in the input image. The value defines
|
|
443
|
-
* the proportion of the conversion. A value of 0% (or 0) is completely
|
|
444
|
-
* transparent. A value of 100% (or 1) leaves the input unchanged. See
|
|
445
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/opacity
|
|
446
|
-
* for more details.
|
|
447
|
-
*/
|
|
448
|
-
opacity?: string;
|
|
449
|
-
/**
|
|
450
|
-
* Applies a linear multiplier to the input image, making it appear more or
|
|
451
|
-
* less bright. A value of 0% (or 0) will create an image that is completely
|
|
452
|
-
* black. A value of 100% (or 1) leaves the input unchanged. Values of an
|
|
453
|
-
* amount over 100% are allowed, providing brighter results. See
|
|
454
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/brightness
|
|
455
|
-
* for more details.
|
|
456
|
-
*/
|
|
457
|
-
brightness?: string;
|
|
458
|
-
/**
|
|
459
|
-
* Adjusts the contrast of the input image. A value of 0% (or 0) will create
|
|
460
|
-
* an image that is completely gray. A value of 100% (or 1) leaves the input
|
|
461
|
-
* unchanged. Values of an amount over 100% are allowed, providing results
|
|
462
|
-
* with more contrast. See
|
|
463
|
-
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/contrast
|
|
464
|
-
* for more details.
|
|
465
|
-
*/
|
|
466
|
-
contrast?: string;
|
|
467
|
-
}
|
|
468
|
-
/**
|
|
469
|
-
* A feature mode for use with filter effects (see
|
|
470
|
-
* `ApplyFilterEffectArgs.featureMode`).
|
|
471
|
-
*/
|
|
472
|
-
export type FilterEffectFeatureMode = "include" | "exclude" | "replace";
|
|
473
|
-
/**
|
|
474
|
-
* The required arguments for the 'maps.apply-filter-effect' command.
|
|
475
|
-
*/
|
|
476
|
-
export interface ApplyFilterEffectArgs {
|
|
477
|
-
/**
|
|
478
|
-
* The layer(s) to which the filter effect will be applied. When defined,
|
|
479
|
-
* the filter only gets set on the corresponding LayerView. If no 'layer' is
|
|
480
|
-
* defined, all applicable layers included in the specified 'maps' will
|
|
481
|
-
* receive the filter effect.
|
|
482
|
-
*/
|
|
483
|
-
layers?: LayersLike;
|
|
484
|
-
/**
|
|
485
|
-
* The map(s) whose layers will receive the filter effect. If no 'maps' nor
|
|
486
|
-
* 'layer' are defined, all applicable layers on all maps will receive the
|
|
487
|
-
* filter effect.
|
|
488
|
-
*/
|
|
489
|
-
maps?: MapsLike;
|
|
490
|
-
/**
|
|
491
|
-
* A where clause for the feature filter. Any legal SQL92 where clause
|
|
492
|
-
* operating on the fields in the 'layer' is allowed. The 'where' clause is
|
|
493
|
-
* ignored if no 'layer' is defined.
|
|
494
|
-
*/
|
|
495
|
-
where?: string;
|
|
496
|
-
/**
|
|
497
|
-
* The features to which the filter effect is applied. If the 'layer'
|
|
498
|
-
* property is set, only features from that layer will be effected;
|
|
499
|
-
* otherwise, the filter effect is applied to each of the features' source
|
|
500
|
-
* layers and all other applicable layers on the 'maps' will receive the
|
|
501
|
-
* 'excludedEffect'.
|
|
502
|
-
*/
|
|
503
|
-
features?: Features;
|
|
504
|
-
/**
|
|
505
|
-
* How the features are used in the filter effect. 'include' includes new
|
|
506
|
-
* features to any that may exist within an existing effect. 'exclude'
|
|
507
|
-
* removes features that may exist within an existing effect. 'replace'
|
|
508
|
-
* replaces any features that may exist within an existing effect. The
|
|
509
|
-
* default is 'include'.
|
|
510
|
-
*/
|
|
511
|
-
featureMode?: FilterEffectFeatureMode;
|
|
512
|
-
/**
|
|
513
|
-
* The geometry to apply to the spatial filter. The spatial relationship, as
|
|
514
|
-
* specified by the 'spatialRelationship' property, will indicate how the
|
|
515
|
-
* geometry should be used to filter features.
|
|
516
|
-
*/
|
|
517
|
-
geometry?: Geometry;
|
|
518
|
-
/**
|
|
519
|
-
* The spatial relationship to filter features in the layer view against the
|
|
520
|
-
* filter 'geometry'.
|
|
521
|
-
*/
|
|
522
|
-
spatialRelationship?: FilterSpatialRelationship;
|
|
523
|
-
/**
|
|
524
|
-
* Specifies a search distance from a given 'geometry' in th spatial filter.
|
|
525
|
-
* In essence, setting this property creates a buffer at the specified size
|
|
526
|
-
* around the input 'geometry'.
|
|
527
|
-
*/
|
|
528
|
-
distance?: number;
|
|
529
|
-
/**
|
|
530
|
-
* The unit for calculating the buffer distance when 'distance' is defined
|
|
531
|
-
* for the spatial filter. If 'units' is not specified, the unit is derived
|
|
532
|
-
* from the filter geometry's spatial reference.
|
|
533
|
-
*/
|
|
534
|
-
units?: FilterDistanceUnits;
|
|
535
|
-
/**
|
|
536
|
-
* A range of time with start and end date. Only the features that fall
|
|
537
|
-
* within this time extent will be included.
|
|
538
|
-
*/
|
|
539
|
-
timeExtent?: TimeExtent;
|
|
540
|
-
/**
|
|
541
|
-
* The effect given to features that match the filter.
|
|
542
|
-
*/
|
|
543
|
-
includedEffect?: FilterEffectSettings;
|
|
544
|
-
/**
|
|
545
|
-
* The effect given to features that don't match the filter.
|
|
546
|
-
*/
|
|
547
|
-
excludedEffect?: FilterEffectSettings;
|
|
548
|
-
}
|
|
549
|
-
/**
|
|
550
|
-
* Result of the "map.get-view-insets" operation.
|
|
551
|
-
*/
|
|
552
|
-
export interface GetViewInsetsArgs {
|
|
553
|
-
/**
|
|
554
|
-
* The width covering the map on the left.
|
|
555
|
-
*/
|
|
556
|
-
left: number;
|
|
557
|
-
/**
|
|
558
|
-
* The width covering the map from above.
|
|
559
|
-
*/
|
|
560
|
-
top: number;
|
|
561
|
-
/**
|
|
562
|
-
* The width covering the map on the right.
|
|
563
|
-
*/
|
|
564
|
-
right: number;
|
|
565
|
-
/**
|
|
566
|
-
* The width covering the map from below.
|
|
567
|
-
*/
|
|
568
|
-
bottom: number;
|
|
569
|
-
}
|
|
570
|
-
/**
|
|
571
|
-
* Arguments for the "map.display-extent-selector" command.
|
|
572
|
-
*/
|
|
573
|
-
export interface DisplayExtentSelectorArgs {
|
|
574
|
-
/**
|
|
575
|
-
* Help text to display above the extent selector overlay to give context to
|
|
576
|
-
* what the user is expected to do.
|
|
577
|
-
*/
|
|
578
|
-
selectorHelpText: string;
|
|
579
|
-
/**
|
|
580
|
-
* The command to execute when the extent selector's Continue button is
|
|
581
|
-
* selected by the user.
|
|
582
|
-
*/
|
|
583
|
-
continueCommand: Action;
|
|
584
|
-
/**
|
|
585
|
-
* The map to display the selector on.
|
|
586
|
-
*/
|
|
587
|
-
maps: MapsLike;
|
|
588
|
-
}
|
|
589
|
-
/**
|
|
590
|
-
* Arguments for the "map.export-image" operation.
|
|
591
|
-
*/
|
|
592
|
-
export interface ExportMapImageArgs {
|
|
593
|
-
/**
|
|
594
|
-
* The name of the file to export to.
|
|
595
|
-
*/
|
|
596
|
-
fileName?: string;
|
|
597
|
-
/**
|
|
598
|
-
* If true, then the file will be stored permanently in a user accessible
|
|
599
|
-
* directory. If false, a temporary file will be created.
|
|
600
|
-
*/
|
|
601
|
-
keepFile?: boolean;
|
|
602
|
-
/**
|
|
603
|
-
* The map to export. If more than one map is specified, the first will be
|
|
604
|
-
* used. If no maps are specified, a default will be used.
|
|
605
|
-
*/
|
|
606
|
-
maps?: MapsLike;
|
|
607
|
-
}
|
|
608
|
-
/**
|
|
609
|
-
* Arguments for the "map.hide" operation.
|
|
610
|
-
*/
|
|
611
|
-
export interface HideMapArgs {
|
|
612
|
-
/**
|
|
613
|
-
* Whether or not to show a spinner while the map is hidden.
|
|
614
|
-
*/
|
|
615
|
-
showSpinner: boolean;
|
|
616
|
-
/**
|
|
617
|
-
* The map to hide.
|
|
618
|
-
*/
|
|
619
|
-
maps: MapsLike;
|
|
620
|
-
}
|
|
621
|
-
/**
|
|
622
|
-
* Arguments for the "map.rotate-by" and "map.rotate-to" commands.
|
|
623
|
-
*/
|
|
624
|
-
export interface MapRotateArgs {
|
|
625
|
-
/**
|
|
626
|
-
* The number of degrees clock-wise, with North being 0 degrees.
|
|
627
|
-
*/
|
|
628
|
-
rotation: number;
|
|
629
|
-
/**
|
|
630
|
-
* The map to rotate.
|
|
631
|
-
*/
|
|
632
|
-
maps?: MapsLike;
|
|
633
|
-
}
|
|
634
|
-
/**
|
|
635
|
-
* Arguments for the "map.replace*" operations.
|
|
636
|
-
*/
|
|
637
|
-
export interface ReplaceMapArgs {
|
|
638
|
-
/**
|
|
639
|
-
* The map with which to replace the current map.
|
|
640
|
-
*/
|
|
641
|
-
replacementMap: EsriMap;
|
|
642
|
-
/**
|
|
643
|
-
* The MapExtension in which to replace the map.
|
|
644
|
-
*/
|
|
645
|
-
mapExtension: MapExtension;
|
|
646
|
-
}
|
|
647
|
-
/**
|
|
648
|
-
* Arguments for the "map.set-view-mode" command.
|
|
649
|
-
*/
|
|
650
|
-
export interface SetViewModeArgs extends HasMaps {
|
|
651
|
-
/**
|
|
652
|
-
* The new view mode for the specified map(s).
|
|
653
|
-
*/
|
|
654
|
-
viewMode: ViewMode;
|
|
655
|
-
}
|
|
656
|
-
/**
|
|
657
|
-
* Arguments for the "map.start-sketch" operation.
|
|
658
|
-
*/
|
|
659
|
-
export interface StartSketchArgs {
|
|
660
|
-
/**
|
|
661
|
-
* The map to sketch on.
|
|
662
|
-
*/
|
|
663
|
-
maps: MapsLike;
|
|
664
|
-
/**
|
|
665
|
-
* The geometry to edit.
|
|
666
|
-
*/
|
|
667
|
-
geometry: Geometry;
|
|
668
|
-
/**
|
|
669
|
-
* The type of geometry to edit.
|
|
670
|
-
*/
|
|
671
|
-
geometryType: GeometryJsonType;
|
|
672
|
-
/**
|
|
673
|
-
* Gets a resume ID for the sketch. Cannot be set.
|
|
674
|
-
*/
|
|
675
|
-
resumeId: string;
|
|
676
|
-
/**
|
|
677
|
-
* The size of the buffer to be created around the geometry. If null or a
|
|
678
|
-
* negative value, no buffer will be created.
|
|
679
|
-
*
|
|
680
|
-
* This is currently only supported for line geometry types.
|
|
681
|
-
*/
|
|
682
|
-
bufferSize: number;
|
|
683
|
-
/**
|
|
684
|
-
* Whether the previous geometry editor settings should be restored after
|
|
685
|
-
* this sketch is stopped.
|
|
686
|
-
*/
|
|
687
|
-
retainEditorSettings: boolean;
|
|
688
|
-
/**
|
|
689
|
-
* The settings to be applied to the sketch.
|
|
690
|
-
*/
|
|
691
|
-
editorSettings: GeometryEditorSettings;
|
|
692
|
-
/**
|
|
693
|
-
* The maximum number of segments permitted for a polyline or polygon
|
|
694
|
-
* sketch. Default is no limit. Mobile only.
|
|
695
|
-
*/
|
|
696
|
-
maxSegments?: number;
|
|
697
|
-
/**
|
|
698
|
-
* An optional symbol to use.
|
|
699
|
-
*/
|
|
700
|
-
symbol?: SymbolJson;
|
|
701
|
-
}
|
|
702
|
-
/**
|
|
703
|
-
* Result of the "map.get-coordinate-transformation" operation.
|
|
704
|
-
*/
|
|
705
|
-
export interface CoordinateTransformation {
|
|
706
|
-
/**
|
|
707
|
-
* The initial coordinate system of the data.
|
|
708
|
-
*/
|
|
709
|
-
inputSpatialReference: SpatialReference;
|
|
710
|
-
/**
|
|
711
|
-
* The coordinate system to project the data into.
|
|
712
|
-
*/
|
|
713
|
-
outputSpatialReference: SpatialReference;
|
|
714
|
-
/**
|
|
715
|
-
* The geographic transformation used to project data between the input
|
|
716
|
-
* coordinate system and the output coordinate system.
|
|
717
|
-
*/
|
|
718
|
-
transformation: GeographicTransformation;
|
|
719
|
-
}
|
|
720
|
-
/**
|
|
721
|
-
* A result geometry which also indicates which map it came from.
|
|
722
|
-
*/
|
|
723
|
-
export interface HasMapGeometry {
|
|
724
|
-
/**
|
|
725
|
-
* The map(s) to target.
|
|
726
|
-
*/
|
|
727
|
-
maps?: MapsLike;
|
|
728
|
-
/**
|
|
729
|
-
* The geometry to target.
|
|
730
|
-
*/
|
|
731
|
-
geometry?: GeometryLike;
|
|
732
|
-
}
|
|
733
|
-
/**
|
|
734
|
-
* Event args for the map.switched event.
|
|
735
|
-
*/
|
|
736
|
-
export interface MapSwitchedEvent extends MapEvent {
|
|
737
|
-
/**
|
|
738
|
-
* The previous map.
|
|
739
|
-
*/
|
|
740
|
-
oldMap: EsriMap;
|
|
741
|
-
}
|
|
742
|
-
/**
|
|
743
|
-
* Event args for the map.initialized event.
|
|
744
|
-
*/
|
|
745
|
-
export interface MapInitializedEvent extends MapEvent {
|
|
746
|
-
/**
|
|
747
|
-
* The amount of time that the map took to load. Mobile only.
|
|
748
|
-
*/
|
|
749
|
-
loadTime: TimeSpan;
|
|
750
|
-
}
|
|
751
|
-
/**
|
|
752
|
-
* Event args for the map.markup-added event.
|
|
753
|
-
*/
|
|
754
|
-
export interface MarkupAddedEvent extends MapEvent {
|
|
755
|
-
/**
|
|
756
|
-
* The markup type of the added markup.
|
|
757
|
-
*/
|
|
758
|
-
markupType: MarkupType;
|
|
759
|
-
}
|
|
760
|
-
/**
|
|
761
|
-
* The type of markup.
|
|
762
|
-
*/
|
|
763
|
-
export type MarkupType = "Unknown" | "Polygon" | "Polyline" | "Text" | "PictureMarker" | "PictureFill" | "Composite" | "Multi";
|
|
764
|
-
export declare class MapCommands extends CommandRegistry {
|
|
765
|
-
protected readonly _prefix = "map";
|
|
766
|
-
/**
|
|
767
|
-
* Adds markup to the map(s).
|
|
768
|
-
*/
|
|
769
|
-
get addMarkup(): Command<AddMarkupArgs | GraphicsLike>;
|
|
770
|
-
/**
|
|
771
|
-
* Add the specified layer(s) to the maps(s). Layers will be inserted in the
|
|
772
|
-
* order specified and will be added above existing layers in the drawing
|
|
773
|
-
* order. Note that an Esri {@link Layer} object can only be added to one
|
|
774
|
-
* map. Web only.
|
|
775
|
-
*
|
|
776
|
-
* @webOnly
|
|
777
|
-
*/
|
|
778
|
-
get addLayers(): Command<AddLayersArgs>;
|
|
779
|
-
/**
|
|
780
|
-
* Applies a Filter Effect to the map(s). Web only.
|
|
781
|
-
*
|
|
782
|
-
* @webOnly
|
|
783
|
-
*/
|
|
784
|
-
get applyFilterEffect(): Command<ApplyFilterEffectArgs>;
|
|
785
|
-
/**
|
|
786
|
-
* Applies a LayerPreset to the map(s). Web only.
|
|
787
|
-
*
|
|
788
|
-
* @webOnly
|
|
789
|
-
*/
|
|
790
|
-
get applyLayerPreset(): Command<ApplyLayerPresetArgs>;
|
|
791
|
-
/**
|
|
792
|
-
* Create a map note. Web only.
|
|
793
|
-
*
|
|
794
|
-
* @webOnly
|
|
795
|
-
*/
|
|
796
|
-
get createNote(): Command<CreateMapNoteArgs>;
|
|
797
|
-
/**
|
|
798
|
-
* Edit an existing map note. Web only.
|
|
799
|
-
*
|
|
800
|
-
* @webOnly
|
|
801
|
-
*/
|
|
802
|
-
get editNote(): Command<EditMapNotesArgs>;
|
|
803
|
-
/**
|
|
804
|
-
* Removes a Filter Effect(s) from the map(s). Web only.
|
|
805
|
-
*
|
|
806
|
-
* @webOnly
|
|
807
|
-
*/
|
|
808
|
-
get removeFilterEffects(): Command<Layers>;
|
|
809
|
-
/**
|
|
810
|
-
* Clears all Filter Effects from the map(s). Web only.
|
|
811
|
-
*
|
|
812
|
-
* @webOnly
|
|
813
|
-
*/
|
|
814
|
-
get clearFilterEffects(): Command<Maps | void>;
|
|
815
|
-
/**
|
|
816
|
-
* Clears all markup from the map(s).
|
|
817
|
-
*/
|
|
818
|
-
get clearMarkup(): Command<ClearMarkupArgs | void>;
|
|
819
|
-
/**
|
|
820
|
-
* Disables the click event handler on the map, so that if the user clicks
|
|
821
|
-
* on the map, the configured handler will not be invoked. Mobile only.
|
|
822
|
-
*
|
|
823
|
-
* @mobileOnly
|
|
824
|
-
*/
|
|
825
|
-
get disableMapClick(): Command<HasMaps>;
|
|
826
|
-
/**
|
|
827
|
-
* Displays a square overlay on the map that allows the user to change the
|
|
828
|
-
* map extent within the overlay. Mobile only.
|
|
829
|
-
*
|
|
830
|
-
* @mobileOnly
|
|
831
|
-
*/
|
|
832
|
-
get displayExtentSelector(): Command<DisplayExtentSelectorArgs>;
|
|
833
|
-
/**
|
|
834
|
-
* Enables the click event handler on the map, so that if the user clicks on
|
|
835
|
-
* the map, the configured handler will be invoked. Mobile only.
|
|
836
|
-
*
|
|
837
|
-
* @mobileOnly
|
|
838
|
-
*/
|
|
839
|
-
get enableMapClick(): Command<HasMaps>;
|
|
840
|
-
/**
|
|
841
|
-
* Zooms to (without animation) one or many features on the targeted map(s).
|
|
842
|
-
* Web only.
|
|
843
|
-
*
|
|
844
|
-
* @webOnly
|
|
845
|
-
*/
|
|
846
|
-
get goToFeatures(): Command<Features>;
|
|
847
|
-
/**
|
|
848
|
-
* Zooms to (without animation) one or many geometries on the targeted
|
|
849
|
-
* map(s). Web only.
|
|
850
|
-
*
|
|
851
|
-
* @webOnly
|
|
852
|
-
*/
|
|
853
|
-
get goToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
854
|
-
/**
|
|
855
|
-
* Zooms to (without animation) the next viewpoint to undo viewpoint changes
|
|
856
|
-
* from zooming to a previous viewpoint.
|
|
857
|
-
*
|
|
858
|
-
* Note that if no map is included as an argument, the command will run for
|
|
859
|
-
* all maps, which could result in unexpected behavior. Web only.
|
|
860
|
-
*
|
|
861
|
-
* @webOnly
|
|
862
|
-
*/
|
|
863
|
-
get goToNextViewpoint(): Command<Maps | void>;
|
|
864
|
-
/**
|
|
865
|
-
* Zooms to (without animation) the previous viewpoint.
|
|
866
|
-
*
|
|
867
|
-
* Note that if no map is included as an argument, the command will run for
|
|
868
|
-
* all maps, which could result in unexpected behavior. Web only.
|
|
869
|
-
*
|
|
870
|
-
* @webOnly
|
|
871
|
-
*/
|
|
872
|
-
get goToPreviousViewpoint(): Command<Maps | void>;
|
|
873
|
-
/**
|
|
874
|
-
* Zooms to (without animation) the given viewpoint. Web only.
|
|
875
|
-
*
|
|
876
|
-
* @webOnly
|
|
877
|
-
*/
|
|
878
|
-
get goToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
|
|
879
|
-
/**
|
|
880
|
-
* Zooms (without animation) the map to a specified, numerical scale. Web
|
|
881
|
-
* only.
|
|
882
|
-
*
|
|
883
|
-
* @webOnly
|
|
884
|
-
*/
|
|
885
|
-
get goToScale(): Command<ZoomToScaleArgs>;
|
|
886
|
-
/**
|
|
887
|
-
* Zooms (without animation) the map to its initial viewpoint. If map is
|
|
888
|
-
* omitted, all maps will be targeted. Web only.
|
|
889
|
-
*
|
|
890
|
-
* @webOnly
|
|
891
|
-
*/
|
|
892
|
-
get goToInitialViewpoint(): Command<Maps | void>;
|
|
893
|
-
/**
|
|
894
|
-
* Go to (without animation) the full extent of the layer(s). If more than
|
|
895
|
-
* one layer is specified, it will zoom to the combined extent of all
|
|
896
|
-
* layers. Web only.
|
|
897
|
-
*
|
|
898
|
-
* @webOnly
|
|
899
|
-
*/
|
|
900
|
-
get goToLayerExtent(): Command<ZoomToLayerArgs>;
|
|
901
|
-
/**
|
|
902
|
-
* Hides the extent selector overlay on the map. Mobile only.
|
|
903
|
-
*
|
|
904
|
-
* @mobileOnly
|
|
905
|
-
*/
|
|
906
|
-
get hideExtentSelector(): Command<HasMaps>;
|
|
907
|
-
/**
|
|
908
|
-
* Show the specified markup collection, if hidden. If no collection is
|
|
909
|
-
* specified the default markup collection will be shown. Web only.
|
|
910
|
-
*
|
|
911
|
-
* @webOnly
|
|
912
|
-
*/
|
|
913
|
-
get hideMarkup(): Command<MarkupArgs | void>;
|
|
914
|
-
/**
|
|
915
|
-
* Pans (without zooming) to one or many features on the targeted map(s).
|
|
916
|
-
*/
|
|
917
|
-
get panToFeatures(): Command<Features>;
|
|
918
|
-
/**
|
|
919
|
-
* Pan (without zooming) to one or many geometries on the targeted map(s).
|
|
920
|
-
* Web only.
|
|
921
|
-
*
|
|
922
|
-
* @webOnly
|
|
923
|
-
*/
|
|
924
|
-
get panToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
925
|
-
/**
|
|
926
|
-
* Pauses sketching on the map. Stores the current sketch editor and
|
|
927
|
-
* geometry for later use. Mobile only.
|
|
928
|
-
*
|
|
929
|
-
* @mobileOnly
|
|
930
|
-
*/
|
|
931
|
-
get pauseSketch(): Command<HasMaps>;
|
|
932
|
-
/**
|
|
933
|
-
* Remove the specified layer(s) from the map(s). Web only.
|
|
934
|
-
*
|
|
935
|
-
* @webOnly
|
|
936
|
-
*/
|
|
937
|
-
get removeLayers(): Command<LayersLike | RemoveLayersArgs>;
|
|
938
|
-
/**
|
|
939
|
-
* Replaces the entire current map in the MapExtension and in the map
|
|
940
|
-
* component with a different map. Mobile only.
|
|
941
|
-
*
|
|
942
|
-
* @mobileOnly
|
|
943
|
-
*/
|
|
944
|
-
get replace(): Command<ReplaceMapArgs>;
|
|
945
|
-
/**
|
|
946
|
-
* Replaces the additional layers on top of an mmpk with a new set of
|
|
947
|
-
* layers, when using mmpk + WebMap. The mmpk part of the map is retained.
|
|
948
|
-
* Mobile only.
|
|
949
|
-
*
|
|
950
|
-
* @mobileOnly
|
|
951
|
-
*/
|
|
952
|
-
get replaceAdditionalLayers(): Command<ReplaceMapArgs>;
|
|
953
|
-
/**
|
|
954
|
-
* Replaces the underlying mmpk part of the map when using mmpk + WebMap.
|
|
955
|
-
* The additional layers on top of the mmpk data are retained. Mobile only.
|
|
956
|
-
*
|
|
957
|
-
* @mobileOnly
|
|
958
|
-
*/
|
|
959
|
-
get replaceMmpk(): Command<ReplaceMapArgs>;
|
|
960
|
-
/**
|
|
961
|
-
* Resumes sketching on the map. Uses the sketch editor and geometry stored
|
|
962
|
-
* when pausing. Mobile only.
|
|
963
|
-
*
|
|
964
|
-
* @mobileOnly
|
|
965
|
-
*/
|
|
966
|
-
get resumeSketch(): Command<HasMaps>;
|
|
967
|
-
/**
|
|
968
|
-
* Rotates the map by the specified amount.
|
|
969
|
-
*/
|
|
970
|
-
get rotateBy(): Command<MapRotateArgs>;
|
|
971
|
-
/**
|
|
972
|
-
* Rotates the map to the specified angle.
|
|
973
|
-
*/
|
|
974
|
-
get rotateTo(): Command<MapRotateArgs>;
|
|
975
|
-
/**
|
|
976
|
-
* Refreshes / reloads the map. Mobile only.
|
|
977
|
-
*
|
|
978
|
-
* @mobileOnly
|
|
979
|
-
*/
|
|
980
|
-
get refresh(): Command<HasMaps>;
|
|
981
|
-
/**
|
|
982
|
-
* Changes the view mode of a map to the specified mode, if supported. If no
|
|
983
|
-
* maps are specified, all maps will be targeted. Web only.
|
|
984
|
-
*
|
|
985
|
-
* @webOnly
|
|
986
|
-
*/
|
|
987
|
-
get setViewMode(): Command<ViewMode | SetViewModeArgs>;
|
|
988
|
-
/**
|
|
989
|
-
* Show the specified markup collection, if hidden. If no collection is
|
|
990
|
-
* specified the default markup collection will be shown. Web only.
|
|
991
|
-
*
|
|
992
|
-
* @webOnly
|
|
993
|
-
*/
|
|
994
|
-
get showMarkup(): Command<MarkupArgs | void>;
|
|
995
|
-
/**
|
|
996
|
-
* Updates a layer in the map. Web only.
|
|
997
|
-
*
|
|
998
|
-
* @webOnly
|
|
999
|
-
*/
|
|
1000
|
-
get updateLayer(): Command<UpdateLayerArgs>;
|
|
1001
|
-
/**
|
|
1002
|
-
* Zooms to one or many features.
|
|
1003
|
-
*/
|
|
1004
|
-
get zoomToFeatures(): Command<Features>;
|
|
1005
|
-
/**
|
|
1006
|
-
* Zooms to one or many geometries. Web only.
|
|
1007
|
-
*
|
|
1008
|
-
* @webOnly
|
|
1009
|
-
*/
|
|
1010
|
-
get zoomToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
1011
|
-
/**
|
|
1012
|
-
* Zooms the map in by one level of detail. Web only.
|
|
1013
|
-
*
|
|
1014
|
-
* @webOnly
|
|
1015
|
-
*/
|
|
1016
|
-
get zoomIn(): Command<Maps | void>;
|
|
1017
|
-
/**
|
|
1018
|
-
* Zooms the map out by one level of detail. Web only.
|
|
1019
|
-
*
|
|
1020
|
-
* @webOnly
|
|
1021
|
-
*/
|
|
1022
|
-
get zoomOut(): Command<Maps | void>;
|
|
1023
|
-
/**
|
|
1024
|
-
* Zooms the map to a specified, numerical scale. Web only.
|
|
1025
|
-
*
|
|
1026
|
-
* @webOnly
|
|
1027
|
-
*/
|
|
1028
|
-
get zoomToScale(): Command<ZoomToScaleArgs>;
|
|
1029
|
-
/**
|
|
1030
|
-
* Zooms the map to its initial viewpoint.
|
|
1031
|
-
*/
|
|
1032
|
-
get zoomToInitialViewpoint(): Command<Maps | void>;
|
|
1033
|
-
/**
|
|
1034
|
-
* Zooms to the next viewpoint to undo viewpoint changes from zooming to a
|
|
1035
|
-
* previous viewpoint.
|
|
1036
|
-
*
|
|
1037
|
-
* Note that if no map is included as an argument, the command will run for
|
|
1038
|
-
* all maps, which could result in unexpected behavior. Web only.
|
|
1039
|
-
*
|
|
1040
|
-
* @webOnly
|
|
1041
|
-
*/
|
|
1042
|
-
get zoomToNextViewpoint(): Command<Maps | void>;
|
|
1043
|
-
/**
|
|
1044
|
-
* Zooms to the previous viewpoint.
|
|
1045
|
-
*
|
|
1046
|
-
* Note that if no map is included as an argument, the command will run for
|
|
1047
|
-
* all maps, which could result in unexpected behavior. Web only.
|
|
1048
|
-
*
|
|
1049
|
-
* @webOnly
|
|
1050
|
-
*/
|
|
1051
|
-
get zoomToPreviousViewpoint(): Command<Maps | void>;
|
|
1052
|
-
/**
|
|
1053
|
-
* Go to the given viewpoint.
|
|
1054
|
-
*/
|
|
1055
|
-
get zoomToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
|
|
1056
|
-
/**
|
|
1057
|
-
* Go to the full extent of the layer(s). If more than one layer is
|
|
1058
|
-
* specified, it will zoom to the combined extent of all layers. Web only.
|
|
1059
|
-
*
|
|
1060
|
-
* @webOnly
|
|
1061
|
-
*/
|
|
1062
|
-
get zoomToLayerExtent(): Command<ZoomToLayerArgs>;
|
|
1063
|
-
/**
|
|
1064
|
-
* Go to the closest min/max scale of the layer. The map will not zoom if it
|
|
1065
|
-
* is currently within the visible scale range. If multiple layers are
|
|
1066
|
-
* provided, it will attempt to zoom to a scale range that makes all of the
|
|
1067
|
-
* layers visible. If this is not possible (i.e. some of the layers' scale
|
|
1068
|
-
* ranges don't overlap), then priority will be given to layers that come
|
|
1069
|
-
* earlier in the sequence. Web only.
|
|
1070
|
-
*
|
|
1071
|
-
* @webOnly
|
|
1072
|
-
*/
|
|
1073
|
-
get zoomToLayerVisibleScale(): Command<ZoomToLayerArgs>;
|
|
1074
|
-
}
|
|
1075
|
-
export declare class MapEvents extends EventRegistry {
|
|
1076
|
-
protected readonly _prefix = "map";
|
|
1077
|
-
/**
|
|
1078
|
-
* Raised when a map has completed initialization. MapEvent used in Web,
|
|
1079
|
-
* MapInitializedEvent used in Mobile.
|
|
1080
|
-
*/
|
|
1081
|
-
get initialized(): Event<MapEvent | MapInitializedEvent>;
|
|
1082
|
-
/**
|
|
1083
|
-
* Raised when a map is about to begin loading during startup. The map can
|
|
1084
|
-
* be swapped with a different map at this point if you want to circumvent
|
|
1085
|
-
* the map load process. For example in an app that supported offline, an
|
|
1086
|
-
* offline map could be swapped in here. Mobile only.
|
|
1087
|
-
*
|
|
1088
|
-
* @mobileOnly
|
|
1089
|
-
*/
|
|
1090
|
-
get initializing(): Event<MapEvent>;
|
|
1091
|
-
/**
|
|
1092
|
-
* Raised when markup is added to the map. Mobile only.
|
|
1093
|
-
*
|
|
1094
|
-
* @mobileOnly
|
|
1095
|
-
*/
|
|
1096
|
-
get markupAdded(): Event<MarkupAddedEvent>;
|
|
1097
|
-
/**
|
|
1098
|
-
* Raised when markup is cleared from the map. Mobile only.
|
|
1099
|
-
*
|
|
1100
|
-
* @mobileOnly
|
|
1101
|
-
*/
|
|
1102
|
-
get markupCleared(): Event<MapEvent>;
|
|
1103
|
-
/**
|
|
1104
|
-
* Raised when the a map navigation (eg. Pan or zoom) is complete. Mobile
|
|
1105
|
-
* only.
|
|
1106
|
-
*
|
|
1107
|
-
* @mobileOnly
|
|
1108
|
-
*/
|
|
1109
|
-
get navigationCompleted(): Event<MapEvent>;
|
|
1110
|
-
/**
|
|
1111
|
-
* Raised when a map refresh completes. Mobile only.
|
|
1112
|
-
*
|
|
1113
|
-
* @mobileOnly
|
|
1114
|
-
*/
|
|
1115
|
-
get refreshed(): Event<MapEvent>;
|
|
1116
|
-
/**
|
|
1117
|
-
* Raised when a map refresh begins. Mobile only.
|
|
1118
|
-
*
|
|
1119
|
-
* @mobileOnly
|
|
1120
|
-
*/
|
|
1121
|
-
get refreshing(): Event<MapEvent>;
|
|
1122
|
-
/**
|
|
1123
|
-
* Raised when the Rotate operation has completed execution. Mobile only.
|
|
1124
|
-
*
|
|
1125
|
-
* @mobileOnly
|
|
1126
|
-
*/
|
|
1127
|
-
get rotated(): Event<MapEvent>;
|
|
1128
|
-
/**
|
|
1129
|
-
* Raised when the Rotate operation is about to be called. Mobile only.
|
|
1130
|
-
*
|
|
1131
|
-
* @mobileOnly
|
|
1132
|
-
*/
|
|
1133
|
-
get rotating(): Event<MapEvent>;
|
|
1134
|
-
/**
|
|
1135
|
-
* Raised when a map is replaced with a different map. Mobile only.
|
|
1136
|
-
*
|
|
1137
|
-
* @mobileOnly
|
|
1138
|
-
*/
|
|
1139
|
-
get switched(): Event<MapSwitchedEvent>;
|
|
1140
|
-
/**
|
|
1141
|
-
* Raised when a map's {@link ViewMode} is changed. This happens when the map
|
|
1142
|
-
* view is changed between a WebMap and a WebScene. Web only.
|
|
1143
|
-
*
|
|
1144
|
-
* @webOnly
|
|
1145
|
-
*/
|
|
1146
|
-
get viewModeChanged(): Event<ViewModeChangedEvent>;
|
|
1147
|
-
/**
|
|
1148
|
-
* Raised when the a map extent is changed. This event is raised in
|
|
1149
|
-
* extremely high frequency - for example, every few pixels the map is
|
|
1150
|
-
* repositioned during a pan.
|
|
1151
|
-
*/
|
|
1152
|
-
get viewpointChanged(): Event<MapEvent>;
|
|
1153
|
-
/**
|
|
1154
|
-
* Raised when a map export operation has completed. Mobile only.
|
|
1155
|
-
*
|
|
1156
|
-
* @mobileOnly
|
|
1157
|
-
*/
|
|
1158
|
-
get imageExported(): Event<ExportMapImageArgs>;
|
|
1159
|
-
}
|
|
1160
|
-
export declare class MapOperations extends OperationRegistry {
|
|
1161
|
-
protected readonly _prefix = "map";
|
|
1162
|
-
/**
|
|
1163
|
-
* Prompts the user to enter and return a coordinate. Web only.
|
|
1164
|
-
*
|
|
1165
|
-
* @webOnly
|
|
1166
|
-
*/
|
|
1167
|
-
get getUserCoordinatesInput(): Operation<GetCoordinateArgs, GetCoordinateResult>;
|
|
1168
|
-
/**
|
|
1169
|
-
* If a map extension ID is specified, returns the coordinate transformation
|
|
1170
|
-
* object for that map. If no map extension ID is specified, returns the
|
|
1171
|
-
* coordinate transformation object of the first available map. The
|
|
1172
|
-
* coordinate transformation object contains information about the input and
|
|
1173
|
-
* output spatial reference, as well as the necessary transformations to
|
|
1174
|
-
* convert between those coordinate systems. Mobile only.
|
|
1175
|
-
*
|
|
1176
|
-
* @mobileOnly
|
|
1177
|
-
*/
|
|
1178
|
-
get getCoordinateTransformation(): Operation<Maps | void, CoordinateTransformation[]>;
|
|
1179
|
-
/**
|
|
1180
|
-
* Exports the currently rendered map to a png image file on disk, and also
|
|
1181
|
-
* returns that image. Mobile only.
|
|
1182
|
-
*
|
|
1183
|
-
* @mobileOnly
|
|
1184
|
-
*/
|
|
1185
|
-
get exportImage(): Operation<ExportMapImageArgs, EnhancedFileData>;
|
|
1186
|
-
/**
|
|
1187
|
-
* Exports the current configuration of the selected map component as a web
|
|
1188
|
-
* map or scene. Web only.
|
|
1189
|
-
*
|
|
1190
|
-
* @webOnly
|
|
1191
|
-
*/
|
|
1192
|
-
get exportWebMapOrScene(): Operation<HasMaps, PortalItemData>;
|
|
1193
|
-
/**
|
|
1194
|
-
* Returns markup from the specified map that are intersected by the
|
|
1195
|
-
* supplied geometry. Web only.
|
|
1196
|
-
*
|
|
1197
|
-
* @webOnly
|
|
1198
|
-
*/
|
|
1199
|
-
get getMarkup(): Operation<GetMarkupArgs, GetMarkupResult>;
|
|
1200
|
-
/**
|
|
1201
|
-
* Returns the extent from the specified map. Web only.
|
|
1202
|
-
*
|
|
1203
|
-
* @webOnly
|
|
1204
|
-
*/
|
|
1205
|
-
get getExtent(): Operation<GetExtentArgs, GetExtentResult>;
|
|
1206
|
-
/**
|
|
1207
|
-
* Returns the geometry that is contained within the square overlay of the
|
|
1208
|
-
* extent selector. Mobile only.
|
|
1209
|
-
*
|
|
1210
|
-
* @mobileOnly
|
|
1211
|
-
*/
|
|
1212
|
-
get getGeometryFromSelector(): Operation<HasMaps, Extent>;
|
|
1213
|
-
/**
|
|
1214
|
-
* Returns the initial viewpoint for the active map or scene of the
|
|
1215
|
-
* specified map. If no map extension is specified, returns the initial
|
|
1216
|
-
* viewpoint for the first available map. Also returns the map(s) used for
|
|
1217
|
-
* the operation. Web only.
|
|
1218
|
-
*
|
|
1219
|
-
* @webOnly
|
|
1220
|
-
*/
|
|
1221
|
-
get getInitialViewpoint(): Operation<Maps | void, GetViewpointResult>;
|
|
1222
|
-
/**
|
|
1223
|
-
* Returns the current viewpoint for the active map or scene of the
|
|
1224
|
-
* specified map. If no map extension is specified, returns the viewpoint
|
|
1225
|
-
* for the first available map. Also returns the map(s) used for the
|
|
1226
|
-
* operation. Web only.
|
|
1227
|
-
*
|
|
1228
|
-
* @webOnly
|
|
1229
|
-
*/
|
|
1230
|
-
get getViewpoint(): Operation<Maps | void, GetViewpointResult>;
|
|
1231
|
-
/**
|
|
1232
|
-
* If a map extension ID is specified, returns the spatial reference for
|
|
1233
|
-
* that map. If no map extension ID is specified, returns the spatial
|
|
1234
|
-
* reference of the first available map.
|
|
1235
|
-
*/
|
|
1236
|
-
get getSpatialReference(): Operation<Maps | void, SpatialReference>;
|
|
1237
|
-
/**
|
|
1238
|
-
* Returns the point at the center of the visible map area. Accounts for
|
|
1239
|
-
* panels displaying overtop of the map. Mobile only.
|
|
1240
|
-
*
|
|
1241
|
-
* @mobileOnly
|
|
1242
|
-
*/
|
|
1243
|
-
get getVisibleCenter(): Operation<HasMaps, Point>;
|
|
1244
|
-
/**
|
|
1245
|
-
* Hides the map. Mobile only.
|
|
1246
|
-
*
|
|
1247
|
-
* @mobileOnly
|
|
1248
|
-
*/
|
|
1249
|
-
get hide(): Operation<HideMapArgs, boolean>;
|
|
1250
|
-
/**
|
|
1251
|
-
* Shows the map if it is hidden. Mobile only.
|
|
1252
|
-
*
|
|
1253
|
-
* @mobileOnly
|
|
1254
|
-
*/
|
|
1255
|
-
get show(): Operation<HasMaps, boolean>;
|
|
1256
|
-
/**
|
|
1257
|
-
* Enables sketching on a map. Mobile only.
|
|
1258
|
-
*
|
|
1259
|
-
* @mobileOnly
|
|
1260
|
-
*/
|
|
1261
|
-
get startSketch(): Operation<StartSketchArgs, Geometry>;
|
|
1262
|
-
/**
|
|
1263
|
-
* Stops sketching on the map. Mobile only.
|
|
1264
|
-
*
|
|
1265
|
-
* @mobileOnly
|
|
1266
|
-
*/
|
|
1267
|
-
get stopSketch(): Operation<HasMaps, Geometry>;
|
|
1268
|
-
/**
|
|
1269
|
-
* Returns the amount of the map that is currently covered by insets such as
|
|
1270
|
-
* the panel component. Mobile only.
|
|
1271
|
-
*
|
|
1272
|
-
* @mobileOnly
|
|
1273
|
-
*/
|
|
1274
|
-
get getViewInsets(): Operation<HasMaps, GetViewInsetsArgs>;
|
|
1275
|
-
}
|
|
1
|
+
import type Graphic from "@arcgis/core/Graphic.js";
|
|
2
|
+
import type EsriMap from "@arcgis/core/Map";
|
|
3
|
+
import type Viewpoint from "@arcgis/core/Viewpoint";
|
|
4
|
+
import type Extent from "@arcgis/core/geometry/Extent";
|
|
5
|
+
import type Geometry from "@arcgis/core/geometry/Geometry";
|
|
6
|
+
import type Point from "@arcgis/core/geometry/Point";
|
|
7
|
+
import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
|
|
8
|
+
import type GeographicTransformation from "@arcgis/core/geometry/support/GeographicTransformation";
|
|
9
|
+
import type Layer from "@arcgis/core/layers/Layer";
|
|
10
|
+
import type { GeometryJsonType } from "@vertigis/arcgis-extensions/json/GeometryJson.js";
|
|
11
|
+
import type { OperationalLayerJson } from "@vertigis/arcgis-extensions/json/OperationalLayerJson.js";
|
|
12
|
+
import type { SymbolJson } from "@vertigis/arcgis-extensions/json/SymbolJson.js";
|
|
13
|
+
import type { LayerPreset } from "@vertigis/arcgis-extensions/layer-preset/LayerPreset";
|
|
14
|
+
import type { LayerExtension } from "@vertigis/arcgis-extensions/mapping/LayerExtension";
|
|
15
|
+
import type { MapExtension, ViewMode } from "@vertigis/arcgis-extensions/mapping/MapExtension";
|
|
16
|
+
import type { Action } from "@vertigis/arcgis-extensions/support/Action";
|
|
17
|
+
import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
|
|
18
|
+
import type { Command } from "../Command.js";
|
|
19
|
+
import { CommandRegistry } from "../CommandRegistry.js";
|
|
20
|
+
import type { TimeSpan } from "../DotNetTypes.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 { Features, FeaturesLike, Geometries, GeometryLike, GraphicsLike, HasMaps, HasUITarget, Layers, LayersLike, Maps, MapsLike, ViewpointLike } from "../common.js";
|
|
26
|
+
import type { EnhancedFileData } from "./file.js";
|
|
27
|
+
import type { PortalItemData } from "./portal.js";
|
|
28
|
+
import type { GeometryEditorSettings } from "./sketching.js";
|
|
29
|
+
/**
|
|
30
|
+
* Levels (z-orders) to which markup can be assigned, listed from high to low.
|
|
31
|
+
*/
|
|
32
|
+
export type MarkupLevel = "ui" | "labels" | "custom3" | "custom2" | "custom1" | "default";
|
|
33
|
+
/**
|
|
34
|
+
* Arguments for the various map events.
|
|
35
|
+
*/
|
|
36
|
+
export interface MapEvent {
|
|
37
|
+
/**
|
|
38
|
+
* The map from which the event was generated. Web only.
|
|
39
|
+
*
|
|
40
|
+
* @webOnly
|
|
41
|
+
*/
|
|
42
|
+
maps?: MapsLike;
|
|
43
|
+
/**
|
|
44
|
+
* The map extension for which the event was generated. This property is
|
|
45
|
+
* required in VertiGIS Studio Mobile. Mobile only.
|
|
46
|
+
*
|
|
47
|
+
* @mobileOnly
|
|
48
|
+
*/
|
|
49
|
+
mapExtension?: MapExtension;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Arguments for the ViewModeChanged event.
|
|
53
|
+
*/
|
|
54
|
+
export interface ViewModeChangedEvent extends MapEvent {
|
|
55
|
+
/**
|
|
56
|
+
* The new ViewMode.
|
|
57
|
+
*/
|
|
58
|
+
viewMode?: ViewMode;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Arguments for the map.zoom-to-viewpoint command.
|
|
62
|
+
*/
|
|
63
|
+
export interface ZoomToViewpointArgs {
|
|
64
|
+
/**
|
|
65
|
+
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
66
|
+
*/
|
|
67
|
+
maps?: MapsLike;
|
|
68
|
+
/**
|
|
69
|
+
* The viewpoint to zoom to.
|
|
70
|
+
*/
|
|
71
|
+
viewpoint: ViewpointLike | string;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* The result of getting a Viewpoint.
|
|
75
|
+
*/
|
|
76
|
+
export interface GetViewpointResult {
|
|
77
|
+
/**
|
|
78
|
+
* The map(s) used in the operation.
|
|
79
|
+
*/
|
|
80
|
+
maps?: MapsLike;
|
|
81
|
+
/**
|
|
82
|
+
* The viewpoint.
|
|
83
|
+
*/
|
|
84
|
+
viewpoint: Viewpoint;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Arguments for the map.zoom-to-layer-extent and
|
|
88
|
+
* map.zoom-to-layer-visible-scale commands.
|
|
89
|
+
*/
|
|
90
|
+
export interface ZoomToLayerArgs {
|
|
91
|
+
/**
|
|
92
|
+
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
93
|
+
*/
|
|
94
|
+
maps?: MapsLike;
|
|
95
|
+
/**
|
|
96
|
+
* The layer(s) to zoom to.
|
|
97
|
+
*/
|
|
98
|
+
layers: LayersLike;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Arguments for the map.zoom-to-scale command.
|
|
102
|
+
*/
|
|
103
|
+
export interface ZoomToScaleArgs {
|
|
104
|
+
/**
|
|
105
|
+
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
106
|
+
*/
|
|
107
|
+
maps?: MapsLike;
|
|
108
|
+
/**
|
|
109
|
+
* The scale to zoom to.
|
|
110
|
+
*/
|
|
111
|
+
scale: number;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* Arguments for the map.zoom-to-features command.
|
|
115
|
+
*/
|
|
116
|
+
export interface ZoomToFeaturesArgs {
|
|
117
|
+
/**
|
|
118
|
+
* The map(s) to zoom. If omitted, all maps will be zoomed.
|
|
119
|
+
*/
|
|
120
|
+
maps?: MapsLike;
|
|
121
|
+
/**
|
|
122
|
+
* The feature(s) to zoom to.
|
|
123
|
+
*/
|
|
124
|
+
features: FeaturesLike;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Arguments for the "map.get-extent" operation.
|
|
128
|
+
*/
|
|
129
|
+
export interface GetExtentArgs {
|
|
130
|
+
/**
|
|
131
|
+
* The map from which to retrieve the extent.
|
|
132
|
+
*/
|
|
133
|
+
maps?: MapsLike;
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Result of the "map.get-extent" operation.
|
|
137
|
+
*/
|
|
138
|
+
export interface GetExtentResult {
|
|
139
|
+
/**
|
|
140
|
+
* The extent for the selected map.
|
|
141
|
+
*/
|
|
142
|
+
geometry: Geometry;
|
|
143
|
+
/**
|
|
144
|
+
* The associated map for the retrieved extent.
|
|
145
|
+
*/
|
|
146
|
+
maps: MapsLike;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Base arguments for markup commands and operations.
|
|
150
|
+
*/
|
|
151
|
+
export interface MarkupArgs extends HasMaps {
|
|
152
|
+
/**
|
|
153
|
+
* The named collection of markup to operate on. If not specified the
|
|
154
|
+
* default markup collection will be used. Some markup collection names are
|
|
155
|
+
* used internally by Web:
|
|
156
|
+
*
|
|
157
|
+
* "default": The default markup layer.
|
|
158
|
+
*
|
|
159
|
+
* "vgs-active-snapping-guides": The active snap point when snapping.
|
|
160
|
+
*
|
|
161
|
+
* "vgs-buffer": Buffer graphics from out of the box buffer tools.
|
|
162
|
+
*
|
|
163
|
+
* "vgs-context-marker": Right click context marker on map.
|
|
164
|
+
*
|
|
165
|
+
* "vgs-dirty-indicator": Invalid geometry indicators used when editing.
|
|
166
|
+
*
|
|
167
|
+
* "vgs-editing-control": Edit frame and vertices while editing geometries.
|
|
168
|
+
*
|
|
169
|
+
* "vgs-location-accuracy": Location accuracy circle when geolocating.
|
|
170
|
+
*
|
|
171
|
+
* "vgs-location-marker-*": Location markers have this prefix followed by
|
|
172
|
+
* the marker id.
|
|
173
|
+
*
|
|
174
|
+
* "vgs-map-notes": Map Notes.
|
|
175
|
+
*
|
|
176
|
+
* "vgs-measurement-labels": Labels on measured graphics.
|
|
177
|
+
*
|
|
178
|
+
* "vgs-other-snapping-guides": Additional snapping point visualizations.
|
|
179
|
+
*
|
|
180
|
+
* "vgs-query": Graphics representing the custom spatial filter for the
|
|
181
|
+
* query builder tool.
|
|
182
|
+
*
|
|
183
|
+
* "vgs-self-snaps": Used internally by snapping.
|
|
184
|
+
*
|
|
185
|
+
* "vgs-sketching": Temporary graphics used while drawing geometries.
|
|
186
|
+
*
|
|
187
|
+
* "vgs-snapping-radius": Snapping radius when snapping is active.
|
|
188
|
+
*
|
|
189
|
+
* "vgs-transient-measurement-labels": Measurement labels used while
|
|
190
|
+
* drawing.
|
|
191
|
+
*
|
|
192
|
+
* Web only.
|
|
193
|
+
*
|
|
194
|
+
* @webOnly
|
|
195
|
+
*/
|
|
196
|
+
collection?: string;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Arguments for the "map.add-markup" command.
|
|
200
|
+
*/
|
|
201
|
+
export interface AddMarkupArgs extends MarkupArgs {
|
|
202
|
+
/**
|
|
203
|
+
* The markup to add to the map. `GraphicsLike` is only available in Web.
|
|
204
|
+
*/
|
|
205
|
+
graphics?: Graphic[] | GraphicsLike;
|
|
206
|
+
/**
|
|
207
|
+
* The level (z-order) to assign the markup to. If not specified uses the
|
|
208
|
+
* same level as default markup. Web only.
|
|
209
|
+
*
|
|
210
|
+
* @webOnly
|
|
211
|
+
*/
|
|
212
|
+
level?: MarkupLevel;
|
|
213
|
+
}
|
|
214
|
+
/**
|
|
215
|
+
* Arguments for the "map.clear-markup" command.
|
|
216
|
+
*
|
|
217
|
+
* @webOnly
|
|
218
|
+
*/
|
|
219
|
+
export interface ClearMarkupArgs extends MarkupArgs {
|
|
220
|
+
/**
|
|
221
|
+
* The markup to clear. If not specified will clear all markup in the
|
|
222
|
+
* selected collection.
|
|
223
|
+
*/
|
|
224
|
+
graphics?: GraphicsLike;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* Arguments for the "map.get-markup" operation.
|
|
228
|
+
*/
|
|
229
|
+
export interface GetMarkupArgs extends MarkupArgs {
|
|
230
|
+
/**
|
|
231
|
+
* The geometry used to bound the retrieved markup. If not specified all
|
|
232
|
+
* markup in the selected collection will be returned.
|
|
233
|
+
*/
|
|
234
|
+
geometry?: Geometry;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Result of the "map.get-markup" operation.
|
|
238
|
+
*/
|
|
239
|
+
export interface GetMarkupResult {
|
|
240
|
+
/**
|
|
241
|
+
* The markup results.
|
|
242
|
+
*/
|
|
243
|
+
graphics: GraphicsLike;
|
|
244
|
+
/**
|
|
245
|
+
* The associated map the markup was retrieved from.
|
|
246
|
+
*/
|
|
247
|
+
maps?: MapsLike;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Represents an operational layer.
|
|
251
|
+
*/
|
|
252
|
+
export type OperationalLayerLike = Layer | OperationalLayerJson | LayerExtension | PortalItemLike;
|
|
253
|
+
/**
|
|
254
|
+
* Arguments for the map.add-layers command.
|
|
255
|
+
*/
|
|
256
|
+
export interface AddLayersArgs {
|
|
257
|
+
/**
|
|
258
|
+
* The layer(s) to add.
|
|
259
|
+
*/
|
|
260
|
+
layers: OperationalLayerLike | OperationalLayerLike[];
|
|
261
|
+
/**
|
|
262
|
+
* The associated map(s) for the layer(s).
|
|
263
|
+
*/
|
|
264
|
+
maps?: MapsLike;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* Arguments for the map.remove-layers command.
|
|
268
|
+
*/
|
|
269
|
+
export interface RemoveLayersArgs {
|
|
270
|
+
/**
|
|
271
|
+
* The layer(s) to remove.
|
|
272
|
+
*/
|
|
273
|
+
layers: LayersLike;
|
|
274
|
+
/**
|
|
275
|
+
* The associated map(s) for the layer(s).
|
|
276
|
+
*/
|
|
277
|
+
maps?: MapsLike;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Arguments for the map.apply-layer-preset command.
|
|
281
|
+
*/
|
|
282
|
+
export interface ApplyLayerPresetArgs {
|
|
283
|
+
/**
|
|
284
|
+
* The map(s) to which the layerPreset will be applied.
|
|
285
|
+
*/
|
|
286
|
+
maps?: MapsLike;
|
|
287
|
+
/**
|
|
288
|
+
* The LayerPreset to apply.
|
|
289
|
+
*/
|
|
290
|
+
layerPreset: LayerPreset;
|
|
291
|
+
}
|
|
292
|
+
/**
|
|
293
|
+
* Arguments for the map.update-layer command.
|
|
294
|
+
*/
|
|
295
|
+
export interface UpdateLayerArgs {
|
|
296
|
+
/**
|
|
297
|
+
* The associated map(s) for the layer(s).
|
|
298
|
+
*/
|
|
299
|
+
maps?: MapsLike;
|
|
300
|
+
/**
|
|
301
|
+
* The web map spec JSON used to update the Layer.
|
|
302
|
+
*/
|
|
303
|
+
layerJson: OperationalLayerJson;
|
|
304
|
+
/**
|
|
305
|
+
* The layer to update. If more than one layer is present, only the first
|
|
306
|
+
* will be updated and the rest will be ignored.
|
|
307
|
+
*/
|
|
308
|
+
layers: LayersLike;
|
|
309
|
+
}
|
|
310
|
+
/**
|
|
311
|
+
* Arguments for the map.create-note command.
|
|
312
|
+
*/
|
|
313
|
+
export interface CreateMapNoteArgs extends HasUITarget {
|
|
314
|
+
/**
|
|
315
|
+
* Optionally the features that can be referenced for inserting snippets.
|
|
316
|
+
*/
|
|
317
|
+
features?: FeaturesLike;
|
|
318
|
+
/**
|
|
319
|
+
* The map that should show the created note.
|
|
320
|
+
*/
|
|
321
|
+
maps?: MapsLike;
|
|
322
|
+
/**
|
|
323
|
+
* The location for the map note.
|
|
324
|
+
*/
|
|
325
|
+
geometry: Point;
|
|
326
|
+
}
|
|
327
|
+
/**
|
|
328
|
+
* Arguments for the map.edit-note command.
|
|
329
|
+
*/
|
|
330
|
+
export interface EditMapNotesArgs extends HasUITarget {
|
|
331
|
+
/**
|
|
332
|
+
* Optionally the features that can be referenced for inserting snippets.
|
|
333
|
+
*/
|
|
334
|
+
features?: FeaturesLike;
|
|
335
|
+
/**
|
|
336
|
+
* The map on which to edit the result.
|
|
337
|
+
*/
|
|
338
|
+
maps: MapsLike;
|
|
339
|
+
/**
|
|
340
|
+
* The geometry from which to attempt to select the Note.
|
|
341
|
+
*/
|
|
342
|
+
geometry?: Point;
|
|
343
|
+
}
|
|
344
|
+
/**
|
|
345
|
+
* Arguments for the map.get-user-coordinates-input operation.
|
|
346
|
+
*/
|
|
347
|
+
export interface GetCoordinateArgs extends HasUITarget {
|
|
348
|
+
/**
|
|
349
|
+
* The map on which to select the result.
|
|
350
|
+
*/
|
|
351
|
+
maps?: MapsLike;
|
|
352
|
+
/**
|
|
353
|
+
* Indicates if the user should be given the option to select a point from
|
|
354
|
+
* the map.
|
|
355
|
+
*/
|
|
356
|
+
allowSelectFromMap?: boolean;
|
|
357
|
+
/**
|
|
358
|
+
* An optional starting coordinate.
|
|
359
|
+
*/
|
|
360
|
+
geometry?: Point;
|
|
361
|
+
/**
|
|
362
|
+
* Optionally override the display text on the complete button. Defaults to
|
|
363
|
+
* 'OK'.
|
|
364
|
+
*/
|
|
365
|
+
completeLabel?: string;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* The result of a map.get-user-coordinates-input operation.
|
|
369
|
+
*/
|
|
370
|
+
export interface GetCoordinateResult {
|
|
371
|
+
/**
|
|
372
|
+
* The result.
|
|
373
|
+
*/
|
|
374
|
+
geometry: Point;
|
|
375
|
+
/**
|
|
376
|
+
* The associated map.
|
|
377
|
+
*/
|
|
378
|
+
maps: MapsLike;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* The unit for calculating the buffer distance when 'distance' is specified for
|
|
382
|
+
* a filter effect.
|
|
383
|
+
*/
|
|
384
|
+
export type FilterDistanceUnits = "feet" | "miles" | "nautical-miles" | "meters" | "kilometers";
|
|
385
|
+
/**
|
|
386
|
+
* The spatial relationship for a filter effect.
|
|
387
|
+
*/
|
|
388
|
+
export type FilterSpatialRelationship = "contains" | "crosses" | "envelope-intersects" | "overlaps" | "touches" | "within" | "disjoint" | "intersects";
|
|
389
|
+
/**
|
|
390
|
+
* A time extent for a filter effect.
|
|
391
|
+
*/
|
|
392
|
+
export interface TimeExtent {
|
|
393
|
+
/**
|
|
394
|
+
* The beginning of the time interval, as either a JavaScript Date object or
|
|
395
|
+
* the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
|
|
396
|
+
*/
|
|
397
|
+
start: Date | number;
|
|
398
|
+
/**
|
|
399
|
+
* The end of the time interval, as either a JavaScript Date object or the
|
|
400
|
+
* number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
|
|
401
|
+
*/
|
|
402
|
+
end: Date | number;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* Filter effect configuration for either the included or excluded filter.
|
|
406
|
+
*/
|
|
407
|
+
export interface FilterEffectSettings {
|
|
408
|
+
/**
|
|
409
|
+
* Converts the input image to grayscale. The value defines the proportion
|
|
410
|
+
* of the conversion. A value of 100% (or 1) is completely grayscale. A
|
|
411
|
+
* value of 0% (or 0) leaves the input unchanged. See
|
|
412
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/grayscale
|
|
413
|
+
* for more details.
|
|
414
|
+
*/
|
|
415
|
+
grayscale?: string;
|
|
416
|
+
/**
|
|
417
|
+
* Converts the input image to sepia. The value defines the proportion of
|
|
418
|
+
* the conversion. A value of 100% (or 1) is completely grayscale. A value
|
|
419
|
+
* of 0% (or 0) leaves the input unchanged. See
|
|
420
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/sepia
|
|
421
|
+
* for more details.
|
|
422
|
+
*/
|
|
423
|
+
sepia?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Applies a hue rotation on the input image. The value defines the number
|
|
426
|
+
* of degrees around the color circle the input samples will be adjusted. A
|
|
427
|
+
* value of 0deg leaves the input unchanged. There is no maximum value; the
|
|
428
|
+
* effect of values above 360deg wraps around. See
|
|
429
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/hue-rotate
|
|
430
|
+
* for more details.
|
|
431
|
+
*/
|
|
432
|
+
hueRotate?: string;
|
|
433
|
+
/**
|
|
434
|
+
* Inverts the samples in the input image. The value defines the proportion
|
|
435
|
+
* of the conversion. A value of 100% (or 1) is completely inverted. A value
|
|
436
|
+
* of 0% (or 0) leaves the input unchanged. See
|
|
437
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/invert
|
|
438
|
+
* for more details.
|
|
439
|
+
*/
|
|
440
|
+
invert?: string;
|
|
441
|
+
/**
|
|
442
|
+
* Applies transparency to the samples in the input image. The value defines
|
|
443
|
+
* the proportion of the conversion. A value of 0% (or 0) is completely
|
|
444
|
+
* transparent. A value of 100% (or 1) leaves the input unchanged. See
|
|
445
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/opacity
|
|
446
|
+
* for more details.
|
|
447
|
+
*/
|
|
448
|
+
opacity?: string;
|
|
449
|
+
/**
|
|
450
|
+
* Applies a linear multiplier to the input image, making it appear more or
|
|
451
|
+
* less bright. A value of 0% (or 0) will create an image that is completely
|
|
452
|
+
* black. A value of 100% (or 1) leaves the input unchanged. Values of an
|
|
453
|
+
* amount over 100% are allowed, providing brighter results. See
|
|
454
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/brightness
|
|
455
|
+
* for more details.
|
|
456
|
+
*/
|
|
457
|
+
brightness?: string;
|
|
458
|
+
/**
|
|
459
|
+
* Adjusts the contrast of the input image. A value of 0% (or 0) will create
|
|
460
|
+
* an image that is completely gray. A value of 100% (or 1) leaves the input
|
|
461
|
+
* unchanged. Values of an amount over 100% are allowed, providing results
|
|
462
|
+
* with more contrast. See
|
|
463
|
+
* https://developer.mozilla.org/en-US/docs/Web/CSS/filter-function/contrast
|
|
464
|
+
* for more details.
|
|
465
|
+
*/
|
|
466
|
+
contrast?: string;
|
|
467
|
+
}
|
|
468
|
+
/**
|
|
469
|
+
* A feature mode for use with filter effects (see
|
|
470
|
+
* `ApplyFilterEffectArgs.featureMode`).
|
|
471
|
+
*/
|
|
472
|
+
export type FilterEffectFeatureMode = "include" | "exclude" | "replace";
|
|
473
|
+
/**
|
|
474
|
+
* The required arguments for the 'maps.apply-filter-effect' command.
|
|
475
|
+
*/
|
|
476
|
+
export interface ApplyFilterEffectArgs {
|
|
477
|
+
/**
|
|
478
|
+
* The layer(s) to which the filter effect will be applied. When defined,
|
|
479
|
+
* the filter only gets set on the corresponding LayerView. If no 'layer' is
|
|
480
|
+
* defined, all applicable layers included in the specified 'maps' will
|
|
481
|
+
* receive the filter effect.
|
|
482
|
+
*/
|
|
483
|
+
layers?: LayersLike;
|
|
484
|
+
/**
|
|
485
|
+
* The map(s) whose layers will receive the filter effect. If no 'maps' nor
|
|
486
|
+
* 'layer' are defined, all applicable layers on all maps will receive the
|
|
487
|
+
* filter effect.
|
|
488
|
+
*/
|
|
489
|
+
maps?: MapsLike;
|
|
490
|
+
/**
|
|
491
|
+
* A where clause for the feature filter. Any legal SQL92 where clause
|
|
492
|
+
* operating on the fields in the 'layer' is allowed. The 'where' clause is
|
|
493
|
+
* ignored if no 'layer' is defined.
|
|
494
|
+
*/
|
|
495
|
+
where?: string;
|
|
496
|
+
/**
|
|
497
|
+
* The features to which the filter effect is applied. If the 'layer'
|
|
498
|
+
* property is set, only features from that layer will be effected;
|
|
499
|
+
* otherwise, the filter effect is applied to each of the features' source
|
|
500
|
+
* layers and all other applicable layers on the 'maps' will receive the
|
|
501
|
+
* 'excludedEffect'.
|
|
502
|
+
*/
|
|
503
|
+
features?: Features;
|
|
504
|
+
/**
|
|
505
|
+
* How the features are used in the filter effect. 'include' includes new
|
|
506
|
+
* features to any that may exist within an existing effect. 'exclude'
|
|
507
|
+
* removes features that may exist within an existing effect. 'replace'
|
|
508
|
+
* replaces any features that may exist within an existing effect. The
|
|
509
|
+
* default is 'include'.
|
|
510
|
+
*/
|
|
511
|
+
featureMode?: FilterEffectFeatureMode;
|
|
512
|
+
/**
|
|
513
|
+
* The geometry to apply to the spatial filter. The spatial relationship, as
|
|
514
|
+
* specified by the 'spatialRelationship' property, will indicate how the
|
|
515
|
+
* geometry should be used to filter features.
|
|
516
|
+
*/
|
|
517
|
+
geometry?: Geometry;
|
|
518
|
+
/**
|
|
519
|
+
* The spatial relationship to filter features in the layer view against the
|
|
520
|
+
* filter 'geometry'.
|
|
521
|
+
*/
|
|
522
|
+
spatialRelationship?: FilterSpatialRelationship;
|
|
523
|
+
/**
|
|
524
|
+
* Specifies a search distance from a given 'geometry' in th spatial filter.
|
|
525
|
+
* In essence, setting this property creates a buffer at the specified size
|
|
526
|
+
* around the input 'geometry'.
|
|
527
|
+
*/
|
|
528
|
+
distance?: number;
|
|
529
|
+
/**
|
|
530
|
+
* The unit for calculating the buffer distance when 'distance' is defined
|
|
531
|
+
* for the spatial filter. If 'units' is not specified, the unit is derived
|
|
532
|
+
* from the filter geometry's spatial reference.
|
|
533
|
+
*/
|
|
534
|
+
units?: FilterDistanceUnits;
|
|
535
|
+
/**
|
|
536
|
+
* A range of time with start and end date. Only the features that fall
|
|
537
|
+
* within this time extent will be included.
|
|
538
|
+
*/
|
|
539
|
+
timeExtent?: TimeExtent;
|
|
540
|
+
/**
|
|
541
|
+
* The effect given to features that match the filter.
|
|
542
|
+
*/
|
|
543
|
+
includedEffect?: FilterEffectSettings;
|
|
544
|
+
/**
|
|
545
|
+
* The effect given to features that don't match the filter.
|
|
546
|
+
*/
|
|
547
|
+
excludedEffect?: FilterEffectSettings;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* Result of the "map.get-view-insets" operation.
|
|
551
|
+
*/
|
|
552
|
+
export interface GetViewInsetsArgs {
|
|
553
|
+
/**
|
|
554
|
+
* The width covering the map on the left.
|
|
555
|
+
*/
|
|
556
|
+
left: number;
|
|
557
|
+
/**
|
|
558
|
+
* The width covering the map from above.
|
|
559
|
+
*/
|
|
560
|
+
top: number;
|
|
561
|
+
/**
|
|
562
|
+
* The width covering the map on the right.
|
|
563
|
+
*/
|
|
564
|
+
right: number;
|
|
565
|
+
/**
|
|
566
|
+
* The width covering the map from below.
|
|
567
|
+
*/
|
|
568
|
+
bottom: number;
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Arguments for the "map.display-extent-selector" command.
|
|
572
|
+
*/
|
|
573
|
+
export interface DisplayExtentSelectorArgs {
|
|
574
|
+
/**
|
|
575
|
+
* Help text to display above the extent selector overlay to give context to
|
|
576
|
+
* what the user is expected to do.
|
|
577
|
+
*/
|
|
578
|
+
selectorHelpText: string;
|
|
579
|
+
/**
|
|
580
|
+
* The command to execute when the extent selector's Continue button is
|
|
581
|
+
* selected by the user.
|
|
582
|
+
*/
|
|
583
|
+
continueCommand: Action;
|
|
584
|
+
/**
|
|
585
|
+
* The map to display the selector on.
|
|
586
|
+
*/
|
|
587
|
+
maps: MapsLike;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* Arguments for the "map.export-image" operation.
|
|
591
|
+
*/
|
|
592
|
+
export interface ExportMapImageArgs {
|
|
593
|
+
/**
|
|
594
|
+
* The name of the file to export to.
|
|
595
|
+
*/
|
|
596
|
+
fileName?: string;
|
|
597
|
+
/**
|
|
598
|
+
* If true, then the file will be stored permanently in a user accessible
|
|
599
|
+
* directory. If false, a temporary file will be created.
|
|
600
|
+
*/
|
|
601
|
+
keepFile?: boolean;
|
|
602
|
+
/**
|
|
603
|
+
* The map to export. If more than one map is specified, the first will be
|
|
604
|
+
* used. If no maps are specified, a default will be used.
|
|
605
|
+
*/
|
|
606
|
+
maps?: MapsLike;
|
|
607
|
+
}
|
|
608
|
+
/**
|
|
609
|
+
* Arguments for the "map.hide" operation.
|
|
610
|
+
*/
|
|
611
|
+
export interface HideMapArgs {
|
|
612
|
+
/**
|
|
613
|
+
* Whether or not to show a spinner while the map is hidden.
|
|
614
|
+
*/
|
|
615
|
+
showSpinner: boolean;
|
|
616
|
+
/**
|
|
617
|
+
* The map to hide.
|
|
618
|
+
*/
|
|
619
|
+
maps: MapsLike;
|
|
620
|
+
}
|
|
621
|
+
/**
|
|
622
|
+
* Arguments for the "map.rotate-by" and "map.rotate-to" commands.
|
|
623
|
+
*/
|
|
624
|
+
export interface MapRotateArgs {
|
|
625
|
+
/**
|
|
626
|
+
* The number of degrees clock-wise, with North being 0 degrees.
|
|
627
|
+
*/
|
|
628
|
+
rotation: number;
|
|
629
|
+
/**
|
|
630
|
+
* The map to rotate.
|
|
631
|
+
*/
|
|
632
|
+
maps?: MapsLike;
|
|
633
|
+
}
|
|
634
|
+
/**
|
|
635
|
+
* Arguments for the "map.replace*" operations.
|
|
636
|
+
*/
|
|
637
|
+
export interface ReplaceMapArgs {
|
|
638
|
+
/**
|
|
639
|
+
* The map with which to replace the current map.
|
|
640
|
+
*/
|
|
641
|
+
replacementMap: EsriMap;
|
|
642
|
+
/**
|
|
643
|
+
* The MapExtension in which to replace the map.
|
|
644
|
+
*/
|
|
645
|
+
mapExtension: MapExtension;
|
|
646
|
+
}
|
|
647
|
+
/**
|
|
648
|
+
* Arguments for the "map.set-view-mode" command.
|
|
649
|
+
*/
|
|
650
|
+
export interface SetViewModeArgs extends HasMaps {
|
|
651
|
+
/**
|
|
652
|
+
* The new view mode for the specified map(s).
|
|
653
|
+
*/
|
|
654
|
+
viewMode: ViewMode;
|
|
655
|
+
}
|
|
656
|
+
/**
|
|
657
|
+
* Arguments for the "map.start-sketch" operation.
|
|
658
|
+
*/
|
|
659
|
+
export interface StartSketchArgs {
|
|
660
|
+
/**
|
|
661
|
+
* The map to sketch on.
|
|
662
|
+
*/
|
|
663
|
+
maps: MapsLike;
|
|
664
|
+
/**
|
|
665
|
+
* The geometry to edit.
|
|
666
|
+
*/
|
|
667
|
+
geometry: Geometry;
|
|
668
|
+
/**
|
|
669
|
+
* The type of geometry to edit.
|
|
670
|
+
*/
|
|
671
|
+
geometryType: GeometryJsonType;
|
|
672
|
+
/**
|
|
673
|
+
* Gets a resume ID for the sketch. Cannot be set.
|
|
674
|
+
*/
|
|
675
|
+
resumeId: string;
|
|
676
|
+
/**
|
|
677
|
+
* The size of the buffer to be created around the geometry. If null or a
|
|
678
|
+
* negative value, no buffer will be created.
|
|
679
|
+
*
|
|
680
|
+
* This is currently only supported for line geometry types.
|
|
681
|
+
*/
|
|
682
|
+
bufferSize: number;
|
|
683
|
+
/**
|
|
684
|
+
* Whether the previous geometry editor settings should be restored after
|
|
685
|
+
* this sketch is stopped.
|
|
686
|
+
*/
|
|
687
|
+
retainEditorSettings: boolean;
|
|
688
|
+
/**
|
|
689
|
+
* The settings to be applied to the sketch.
|
|
690
|
+
*/
|
|
691
|
+
editorSettings: GeometryEditorSettings;
|
|
692
|
+
/**
|
|
693
|
+
* The maximum number of segments permitted for a polyline or polygon
|
|
694
|
+
* sketch. Default is no limit. Mobile only.
|
|
695
|
+
*/
|
|
696
|
+
maxSegments?: number;
|
|
697
|
+
/**
|
|
698
|
+
* An optional symbol to use.
|
|
699
|
+
*/
|
|
700
|
+
symbol?: SymbolJson;
|
|
701
|
+
}
|
|
702
|
+
/**
|
|
703
|
+
* Result of the "map.get-coordinate-transformation" operation.
|
|
704
|
+
*/
|
|
705
|
+
export interface CoordinateTransformation {
|
|
706
|
+
/**
|
|
707
|
+
* The initial coordinate system of the data.
|
|
708
|
+
*/
|
|
709
|
+
inputSpatialReference: SpatialReference;
|
|
710
|
+
/**
|
|
711
|
+
* The coordinate system to project the data into.
|
|
712
|
+
*/
|
|
713
|
+
outputSpatialReference: SpatialReference;
|
|
714
|
+
/**
|
|
715
|
+
* The geographic transformation used to project data between the input
|
|
716
|
+
* coordinate system and the output coordinate system.
|
|
717
|
+
*/
|
|
718
|
+
transformation: GeographicTransformation;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* A result geometry which also indicates which map it came from.
|
|
722
|
+
*/
|
|
723
|
+
export interface HasMapGeometry {
|
|
724
|
+
/**
|
|
725
|
+
* The map(s) to target.
|
|
726
|
+
*/
|
|
727
|
+
maps?: MapsLike;
|
|
728
|
+
/**
|
|
729
|
+
* The geometry to target.
|
|
730
|
+
*/
|
|
731
|
+
geometry?: GeometryLike;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* Event args for the map.switched event.
|
|
735
|
+
*/
|
|
736
|
+
export interface MapSwitchedEvent extends MapEvent {
|
|
737
|
+
/**
|
|
738
|
+
* The previous map.
|
|
739
|
+
*/
|
|
740
|
+
oldMap: EsriMap;
|
|
741
|
+
}
|
|
742
|
+
/**
|
|
743
|
+
* Event args for the map.initialized event.
|
|
744
|
+
*/
|
|
745
|
+
export interface MapInitializedEvent extends MapEvent {
|
|
746
|
+
/**
|
|
747
|
+
* The amount of time that the map took to load. Mobile only.
|
|
748
|
+
*/
|
|
749
|
+
loadTime: TimeSpan;
|
|
750
|
+
}
|
|
751
|
+
/**
|
|
752
|
+
* Event args for the map.markup-added event.
|
|
753
|
+
*/
|
|
754
|
+
export interface MarkupAddedEvent extends MapEvent {
|
|
755
|
+
/**
|
|
756
|
+
* The markup type of the added markup.
|
|
757
|
+
*/
|
|
758
|
+
markupType: MarkupType;
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* The type of markup.
|
|
762
|
+
*/
|
|
763
|
+
export type MarkupType = "Unknown" | "Polygon" | "Polyline" | "Text" | "PictureMarker" | "PictureFill" | "Composite" | "Multi";
|
|
764
|
+
export declare class MapCommands extends CommandRegistry {
|
|
765
|
+
protected readonly _prefix = "map";
|
|
766
|
+
/**
|
|
767
|
+
* Adds markup to the map(s).
|
|
768
|
+
*/
|
|
769
|
+
get addMarkup(): Command<AddMarkupArgs | GraphicsLike>;
|
|
770
|
+
/**
|
|
771
|
+
* Add the specified layer(s) to the maps(s). Layers will be inserted in the
|
|
772
|
+
* order specified and will be added above existing layers in the drawing
|
|
773
|
+
* order. Note that an Esri {@link Layer} object can only be added to one
|
|
774
|
+
* map. Web only.
|
|
775
|
+
*
|
|
776
|
+
* @webOnly
|
|
777
|
+
*/
|
|
778
|
+
get addLayers(): Command<AddLayersArgs>;
|
|
779
|
+
/**
|
|
780
|
+
* Applies a Filter Effect to the map(s). Web only.
|
|
781
|
+
*
|
|
782
|
+
* @webOnly
|
|
783
|
+
*/
|
|
784
|
+
get applyFilterEffect(): Command<ApplyFilterEffectArgs>;
|
|
785
|
+
/**
|
|
786
|
+
* Applies a LayerPreset to the map(s). Web only.
|
|
787
|
+
*
|
|
788
|
+
* @webOnly
|
|
789
|
+
*/
|
|
790
|
+
get applyLayerPreset(): Command<ApplyLayerPresetArgs>;
|
|
791
|
+
/**
|
|
792
|
+
* Create a map note. Web only.
|
|
793
|
+
*
|
|
794
|
+
* @webOnly
|
|
795
|
+
*/
|
|
796
|
+
get createNote(): Command<CreateMapNoteArgs>;
|
|
797
|
+
/**
|
|
798
|
+
* Edit an existing map note. Web only.
|
|
799
|
+
*
|
|
800
|
+
* @webOnly
|
|
801
|
+
*/
|
|
802
|
+
get editNote(): Command<EditMapNotesArgs>;
|
|
803
|
+
/**
|
|
804
|
+
* Removes a Filter Effect(s) from the map(s). Web only.
|
|
805
|
+
*
|
|
806
|
+
* @webOnly
|
|
807
|
+
*/
|
|
808
|
+
get removeFilterEffects(): Command<Layers>;
|
|
809
|
+
/**
|
|
810
|
+
* Clears all Filter Effects from the map(s). Web only.
|
|
811
|
+
*
|
|
812
|
+
* @webOnly
|
|
813
|
+
*/
|
|
814
|
+
get clearFilterEffects(): Command<Maps | void>;
|
|
815
|
+
/**
|
|
816
|
+
* Clears all markup from the map(s).
|
|
817
|
+
*/
|
|
818
|
+
get clearMarkup(): Command<ClearMarkupArgs | void>;
|
|
819
|
+
/**
|
|
820
|
+
* Disables the click event handler on the map, so that if the user clicks
|
|
821
|
+
* on the map, the configured handler will not be invoked. Mobile only.
|
|
822
|
+
*
|
|
823
|
+
* @mobileOnly
|
|
824
|
+
*/
|
|
825
|
+
get disableMapClick(): Command<HasMaps>;
|
|
826
|
+
/**
|
|
827
|
+
* Displays a square overlay on the map that allows the user to change the
|
|
828
|
+
* map extent within the overlay. Mobile only.
|
|
829
|
+
*
|
|
830
|
+
* @mobileOnly
|
|
831
|
+
*/
|
|
832
|
+
get displayExtentSelector(): Command<DisplayExtentSelectorArgs>;
|
|
833
|
+
/**
|
|
834
|
+
* Enables the click event handler on the map, so that if the user clicks on
|
|
835
|
+
* the map, the configured handler will be invoked. Mobile only.
|
|
836
|
+
*
|
|
837
|
+
* @mobileOnly
|
|
838
|
+
*/
|
|
839
|
+
get enableMapClick(): Command<HasMaps>;
|
|
840
|
+
/**
|
|
841
|
+
* Zooms to (without animation) one or many features on the targeted map(s).
|
|
842
|
+
* Web only.
|
|
843
|
+
*
|
|
844
|
+
* @webOnly
|
|
845
|
+
*/
|
|
846
|
+
get goToFeatures(): Command<Features>;
|
|
847
|
+
/**
|
|
848
|
+
* Zooms to (without animation) one or many geometries on the targeted
|
|
849
|
+
* map(s). Web only.
|
|
850
|
+
*
|
|
851
|
+
* @webOnly
|
|
852
|
+
*/
|
|
853
|
+
get goToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
854
|
+
/**
|
|
855
|
+
* Zooms to (without animation) the next viewpoint to undo viewpoint changes
|
|
856
|
+
* from zooming to a previous viewpoint.
|
|
857
|
+
*
|
|
858
|
+
* Note that if no map is included as an argument, the command will run for
|
|
859
|
+
* all maps, which could result in unexpected behavior. Web only.
|
|
860
|
+
*
|
|
861
|
+
* @webOnly
|
|
862
|
+
*/
|
|
863
|
+
get goToNextViewpoint(): Command<Maps | void>;
|
|
864
|
+
/**
|
|
865
|
+
* Zooms to (without animation) the previous viewpoint.
|
|
866
|
+
*
|
|
867
|
+
* Note that if no map is included as an argument, the command will run for
|
|
868
|
+
* all maps, which could result in unexpected behavior. Web only.
|
|
869
|
+
*
|
|
870
|
+
* @webOnly
|
|
871
|
+
*/
|
|
872
|
+
get goToPreviousViewpoint(): Command<Maps | void>;
|
|
873
|
+
/**
|
|
874
|
+
* Zooms to (without animation) the given viewpoint. Web only.
|
|
875
|
+
*
|
|
876
|
+
* @webOnly
|
|
877
|
+
*/
|
|
878
|
+
get goToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
|
|
879
|
+
/**
|
|
880
|
+
* Zooms (without animation) the map to a specified, numerical scale. Web
|
|
881
|
+
* only.
|
|
882
|
+
*
|
|
883
|
+
* @webOnly
|
|
884
|
+
*/
|
|
885
|
+
get goToScale(): Command<ZoomToScaleArgs>;
|
|
886
|
+
/**
|
|
887
|
+
* Zooms (without animation) the map to its initial viewpoint. If map is
|
|
888
|
+
* omitted, all maps will be targeted. Web only.
|
|
889
|
+
*
|
|
890
|
+
* @webOnly
|
|
891
|
+
*/
|
|
892
|
+
get goToInitialViewpoint(): Command<Maps | void>;
|
|
893
|
+
/**
|
|
894
|
+
* Go to (without animation) the full extent of the layer(s). If more than
|
|
895
|
+
* one layer is specified, it will zoom to the combined extent of all
|
|
896
|
+
* layers. Web only.
|
|
897
|
+
*
|
|
898
|
+
* @webOnly
|
|
899
|
+
*/
|
|
900
|
+
get goToLayerExtent(): Command<ZoomToLayerArgs>;
|
|
901
|
+
/**
|
|
902
|
+
* Hides the extent selector overlay on the map. Mobile only.
|
|
903
|
+
*
|
|
904
|
+
* @mobileOnly
|
|
905
|
+
*/
|
|
906
|
+
get hideExtentSelector(): Command<HasMaps>;
|
|
907
|
+
/**
|
|
908
|
+
* Show the specified markup collection, if hidden. If no collection is
|
|
909
|
+
* specified the default markup collection will be shown. Web only.
|
|
910
|
+
*
|
|
911
|
+
* @webOnly
|
|
912
|
+
*/
|
|
913
|
+
get hideMarkup(): Command<MarkupArgs | void>;
|
|
914
|
+
/**
|
|
915
|
+
* Pans (without zooming) to one or many features on the targeted map(s).
|
|
916
|
+
*/
|
|
917
|
+
get panToFeatures(): Command<Features>;
|
|
918
|
+
/**
|
|
919
|
+
* Pan (without zooming) to one or many geometries on the targeted map(s).
|
|
920
|
+
* Web only.
|
|
921
|
+
*
|
|
922
|
+
* @webOnly
|
|
923
|
+
*/
|
|
924
|
+
get panToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
925
|
+
/**
|
|
926
|
+
* Pauses sketching on the map. Stores the current sketch editor and
|
|
927
|
+
* geometry for later use. Mobile only.
|
|
928
|
+
*
|
|
929
|
+
* @mobileOnly
|
|
930
|
+
*/
|
|
931
|
+
get pauseSketch(): Command<HasMaps>;
|
|
932
|
+
/**
|
|
933
|
+
* Remove the specified layer(s) from the map(s). Web only.
|
|
934
|
+
*
|
|
935
|
+
* @webOnly
|
|
936
|
+
*/
|
|
937
|
+
get removeLayers(): Command<LayersLike | RemoveLayersArgs>;
|
|
938
|
+
/**
|
|
939
|
+
* Replaces the entire current map in the MapExtension and in the map
|
|
940
|
+
* component with a different map. Mobile only.
|
|
941
|
+
*
|
|
942
|
+
* @mobileOnly
|
|
943
|
+
*/
|
|
944
|
+
get replace(): Command<ReplaceMapArgs>;
|
|
945
|
+
/**
|
|
946
|
+
* Replaces the additional layers on top of an mmpk with a new set of
|
|
947
|
+
* layers, when using mmpk + WebMap. The mmpk part of the map is retained.
|
|
948
|
+
* Mobile only.
|
|
949
|
+
*
|
|
950
|
+
* @mobileOnly
|
|
951
|
+
*/
|
|
952
|
+
get replaceAdditionalLayers(): Command<ReplaceMapArgs>;
|
|
953
|
+
/**
|
|
954
|
+
* Replaces the underlying mmpk part of the map when using mmpk + WebMap.
|
|
955
|
+
* The additional layers on top of the mmpk data are retained. Mobile only.
|
|
956
|
+
*
|
|
957
|
+
* @mobileOnly
|
|
958
|
+
*/
|
|
959
|
+
get replaceMmpk(): Command<ReplaceMapArgs>;
|
|
960
|
+
/**
|
|
961
|
+
* Resumes sketching on the map. Uses the sketch editor and geometry stored
|
|
962
|
+
* when pausing. Mobile only.
|
|
963
|
+
*
|
|
964
|
+
* @mobileOnly
|
|
965
|
+
*/
|
|
966
|
+
get resumeSketch(): Command<HasMaps>;
|
|
967
|
+
/**
|
|
968
|
+
* Rotates the map by the specified amount.
|
|
969
|
+
*/
|
|
970
|
+
get rotateBy(): Command<MapRotateArgs>;
|
|
971
|
+
/**
|
|
972
|
+
* Rotates the map to the specified angle.
|
|
973
|
+
*/
|
|
974
|
+
get rotateTo(): Command<MapRotateArgs>;
|
|
975
|
+
/**
|
|
976
|
+
* Refreshes / reloads the map. Mobile only.
|
|
977
|
+
*
|
|
978
|
+
* @mobileOnly
|
|
979
|
+
*/
|
|
980
|
+
get refresh(): Command<HasMaps>;
|
|
981
|
+
/**
|
|
982
|
+
* Changes the view mode of a map to the specified mode, if supported. If no
|
|
983
|
+
* maps are specified, all maps will be targeted. Web only.
|
|
984
|
+
*
|
|
985
|
+
* @webOnly
|
|
986
|
+
*/
|
|
987
|
+
get setViewMode(): Command<ViewMode | SetViewModeArgs>;
|
|
988
|
+
/**
|
|
989
|
+
* Show the specified markup collection, if hidden. If no collection is
|
|
990
|
+
* specified the default markup collection will be shown. Web only.
|
|
991
|
+
*
|
|
992
|
+
* @webOnly
|
|
993
|
+
*/
|
|
994
|
+
get showMarkup(): Command<MarkupArgs | void>;
|
|
995
|
+
/**
|
|
996
|
+
* Updates a layer in the map. Web only.
|
|
997
|
+
*
|
|
998
|
+
* @webOnly
|
|
999
|
+
*/
|
|
1000
|
+
get updateLayer(): Command<UpdateLayerArgs>;
|
|
1001
|
+
/**
|
|
1002
|
+
* Zooms to one or many features.
|
|
1003
|
+
*/
|
|
1004
|
+
get zoomToFeatures(): Command<Features>;
|
|
1005
|
+
/**
|
|
1006
|
+
* Zooms to one or many geometries. Web only.
|
|
1007
|
+
*
|
|
1008
|
+
* @webOnly
|
|
1009
|
+
*/
|
|
1010
|
+
get zoomToGeometry(): Command<Geometries | HasMapGeometry>;
|
|
1011
|
+
/**
|
|
1012
|
+
* Zooms the map in by one level of detail. Web only.
|
|
1013
|
+
*
|
|
1014
|
+
* @webOnly
|
|
1015
|
+
*/
|
|
1016
|
+
get zoomIn(): Command<Maps | void>;
|
|
1017
|
+
/**
|
|
1018
|
+
* Zooms the map out by one level of detail. Web only.
|
|
1019
|
+
*
|
|
1020
|
+
* @webOnly
|
|
1021
|
+
*/
|
|
1022
|
+
get zoomOut(): Command<Maps | void>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Zooms the map to a specified, numerical scale. Web only.
|
|
1025
|
+
*
|
|
1026
|
+
* @webOnly
|
|
1027
|
+
*/
|
|
1028
|
+
get zoomToScale(): Command<ZoomToScaleArgs>;
|
|
1029
|
+
/**
|
|
1030
|
+
* Zooms the map to its initial viewpoint.
|
|
1031
|
+
*/
|
|
1032
|
+
get zoomToInitialViewpoint(): Command<Maps | void>;
|
|
1033
|
+
/**
|
|
1034
|
+
* Zooms to the next viewpoint to undo viewpoint changes from zooming to a
|
|
1035
|
+
* previous viewpoint.
|
|
1036
|
+
*
|
|
1037
|
+
* Note that if no map is included as an argument, the command will run for
|
|
1038
|
+
* all maps, which could result in unexpected behavior. Web only.
|
|
1039
|
+
*
|
|
1040
|
+
* @webOnly
|
|
1041
|
+
*/
|
|
1042
|
+
get zoomToNextViewpoint(): Command<Maps | void>;
|
|
1043
|
+
/**
|
|
1044
|
+
* Zooms to the previous viewpoint.
|
|
1045
|
+
*
|
|
1046
|
+
* Note that if no map is included as an argument, the command will run for
|
|
1047
|
+
* all maps, which could result in unexpected behavior. Web only.
|
|
1048
|
+
*
|
|
1049
|
+
* @webOnly
|
|
1050
|
+
*/
|
|
1051
|
+
get zoomToPreviousViewpoint(): Command<Maps | void>;
|
|
1052
|
+
/**
|
|
1053
|
+
* Go to the given viewpoint.
|
|
1054
|
+
*/
|
|
1055
|
+
get zoomToViewpoint(): Command<ZoomToViewpointArgs | ViewpointLike>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Go to the full extent of the layer(s). If more than one layer is
|
|
1058
|
+
* specified, it will zoom to the combined extent of all layers. Web only.
|
|
1059
|
+
*
|
|
1060
|
+
* @webOnly
|
|
1061
|
+
*/
|
|
1062
|
+
get zoomToLayerExtent(): Command<ZoomToLayerArgs>;
|
|
1063
|
+
/**
|
|
1064
|
+
* Go to the closest min/max scale of the layer. The map will not zoom if it
|
|
1065
|
+
* is currently within the visible scale range. If multiple layers are
|
|
1066
|
+
* provided, it will attempt to zoom to a scale range that makes all of the
|
|
1067
|
+
* layers visible. If this is not possible (i.e. some of the layers' scale
|
|
1068
|
+
* ranges don't overlap), then priority will be given to layers that come
|
|
1069
|
+
* earlier in the sequence. Web only.
|
|
1070
|
+
*
|
|
1071
|
+
* @webOnly
|
|
1072
|
+
*/
|
|
1073
|
+
get zoomToLayerVisibleScale(): Command<ZoomToLayerArgs>;
|
|
1074
|
+
}
|
|
1075
|
+
export declare class MapEvents extends EventRegistry {
|
|
1076
|
+
protected readonly _prefix = "map";
|
|
1077
|
+
/**
|
|
1078
|
+
* Raised when a map has completed initialization. MapEvent used in Web,
|
|
1079
|
+
* MapInitializedEvent used in Mobile.
|
|
1080
|
+
*/
|
|
1081
|
+
get initialized(): Event<MapEvent | MapInitializedEvent>;
|
|
1082
|
+
/**
|
|
1083
|
+
* Raised when a map is about to begin loading during startup. The map can
|
|
1084
|
+
* be swapped with a different map at this point if you want to circumvent
|
|
1085
|
+
* the map load process. For example in an app that supported offline, an
|
|
1086
|
+
* offline map could be swapped in here. Mobile only.
|
|
1087
|
+
*
|
|
1088
|
+
* @mobileOnly
|
|
1089
|
+
*/
|
|
1090
|
+
get initializing(): Event<MapEvent>;
|
|
1091
|
+
/**
|
|
1092
|
+
* Raised when markup is added to the map. Mobile only.
|
|
1093
|
+
*
|
|
1094
|
+
* @mobileOnly
|
|
1095
|
+
*/
|
|
1096
|
+
get markupAdded(): Event<MarkupAddedEvent>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Raised when markup is cleared from the map. Mobile only.
|
|
1099
|
+
*
|
|
1100
|
+
* @mobileOnly
|
|
1101
|
+
*/
|
|
1102
|
+
get markupCleared(): Event<MapEvent>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Raised when the a map navigation (eg. Pan or zoom) is complete. Mobile
|
|
1105
|
+
* only.
|
|
1106
|
+
*
|
|
1107
|
+
* @mobileOnly
|
|
1108
|
+
*/
|
|
1109
|
+
get navigationCompleted(): Event<MapEvent>;
|
|
1110
|
+
/**
|
|
1111
|
+
* Raised when a map refresh completes. Mobile only.
|
|
1112
|
+
*
|
|
1113
|
+
* @mobileOnly
|
|
1114
|
+
*/
|
|
1115
|
+
get refreshed(): Event<MapEvent>;
|
|
1116
|
+
/**
|
|
1117
|
+
* Raised when a map refresh begins. Mobile only.
|
|
1118
|
+
*
|
|
1119
|
+
* @mobileOnly
|
|
1120
|
+
*/
|
|
1121
|
+
get refreshing(): Event<MapEvent>;
|
|
1122
|
+
/**
|
|
1123
|
+
* Raised when the Rotate operation has completed execution. Mobile only.
|
|
1124
|
+
*
|
|
1125
|
+
* @mobileOnly
|
|
1126
|
+
*/
|
|
1127
|
+
get rotated(): Event<MapEvent>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Raised when the Rotate operation is about to be called. Mobile only.
|
|
1130
|
+
*
|
|
1131
|
+
* @mobileOnly
|
|
1132
|
+
*/
|
|
1133
|
+
get rotating(): Event<MapEvent>;
|
|
1134
|
+
/**
|
|
1135
|
+
* Raised when a map is replaced with a different map. Mobile only.
|
|
1136
|
+
*
|
|
1137
|
+
* @mobileOnly
|
|
1138
|
+
*/
|
|
1139
|
+
get switched(): Event<MapSwitchedEvent>;
|
|
1140
|
+
/**
|
|
1141
|
+
* Raised when a map's {@link ViewMode} is changed. This happens when the map
|
|
1142
|
+
* view is changed between a WebMap and a WebScene. Web only.
|
|
1143
|
+
*
|
|
1144
|
+
* @webOnly
|
|
1145
|
+
*/
|
|
1146
|
+
get viewModeChanged(): Event<ViewModeChangedEvent>;
|
|
1147
|
+
/**
|
|
1148
|
+
* Raised when the a map extent is changed. This event is raised in
|
|
1149
|
+
* extremely high frequency - for example, every few pixels the map is
|
|
1150
|
+
* repositioned during a pan.
|
|
1151
|
+
*/
|
|
1152
|
+
get viewpointChanged(): Event<MapEvent>;
|
|
1153
|
+
/**
|
|
1154
|
+
* Raised when a map export operation has completed. Mobile only.
|
|
1155
|
+
*
|
|
1156
|
+
* @mobileOnly
|
|
1157
|
+
*/
|
|
1158
|
+
get imageExported(): Event<ExportMapImageArgs>;
|
|
1159
|
+
}
|
|
1160
|
+
export declare class MapOperations extends OperationRegistry {
|
|
1161
|
+
protected readonly _prefix = "map";
|
|
1162
|
+
/**
|
|
1163
|
+
* Prompts the user to enter and return a coordinate. Web only.
|
|
1164
|
+
*
|
|
1165
|
+
* @webOnly
|
|
1166
|
+
*/
|
|
1167
|
+
get getUserCoordinatesInput(): Operation<GetCoordinateArgs, GetCoordinateResult>;
|
|
1168
|
+
/**
|
|
1169
|
+
* If a map extension ID is specified, returns the coordinate transformation
|
|
1170
|
+
* object for that map. If no map extension ID is specified, returns the
|
|
1171
|
+
* coordinate transformation object of the first available map. The
|
|
1172
|
+
* coordinate transformation object contains information about the input and
|
|
1173
|
+
* output spatial reference, as well as the necessary transformations to
|
|
1174
|
+
* convert between those coordinate systems. Mobile only.
|
|
1175
|
+
*
|
|
1176
|
+
* @mobileOnly
|
|
1177
|
+
*/
|
|
1178
|
+
get getCoordinateTransformation(): Operation<Maps | void, CoordinateTransformation[]>;
|
|
1179
|
+
/**
|
|
1180
|
+
* Exports the currently rendered map to a png image file on disk, and also
|
|
1181
|
+
* returns that image. Mobile only.
|
|
1182
|
+
*
|
|
1183
|
+
* @mobileOnly
|
|
1184
|
+
*/
|
|
1185
|
+
get exportImage(): Operation<ExportMapImageArgs, EnhancedFileData>;
|
|
1186
|
+
/**
|
|
1187
|
+
* Exports the current configuration of the selected map component as a web
|
|
1188
|
+
* map or scene. Web only.
|
|
1189
|
+
*
|
|
1190
|
+
* @webOnly
|
|
1191
|
+
*/
|
|
1192
|
+
get exportWebMapOrScene(): Operation<HasMaps, PortalItemData>;
|
|
1193
|
+
/**
|
|
1194
|
+
* Returns markup from the specified map that are intersected by the
|
|
1195
|
+
* supplied geometry. Web only.
|
|
1196
|
+
*
|
|
1197
|
+
* @webOnly
|
|
1198
|
+
*/
|
|
1199
|
+
get getMarkup(): Operation<GetMarkupArgs, GetMarkupResult>;
|
|
1200
|
+
/**
|
|
1201
|
+
* Returns the extent from the specified map. Web only.
|
|
1202
|
+
*
|
|
1203
|
+
* @webOnly
|
|
1204
|
+
*/
|
|
1205
|
+
get getExtent(): Operation<GetExtentArgs, GetExtentResult>;
|
|
1206
|
+
/**
|
|
1207
|
+
* Returns the geometry that is contained within the square overlay of the
|
|
1208
|
+
* extent selector. Mobile only.
|
|
1209
|
+
*
|
|
1210
|
+
* @mobileOnly
|
|
1211
|
+
*/
|
|
1212
|
+
get getGeometryFromSelector(): Operation<HasMaps, Extent>;
|
|
1213
|
+
/**
|
|
1214
|
+
* Returns the initial viewpoint for the active map or scene of the
|
|
1215
|
+
* specified map. If no map extension is specified, returns the initial
|
|
1216
|
+
* viewpoint for the first available map. Also returns the map(s) used for
|
|
1217
|
+
* the operation. Web only.
|
|
1218
|
+
*
|
|
1219
|
+
* @webOnly
|
|
1220
|
+
*/
|
|
1221
|
+
get getInitialViewpoint(): Operation<Maps | void, GetViewpointResult>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Returns the current viewpoint for the active map or scene of the
|
|
1224
|
+
* specified map. If no map extension is specified, returns the viewpoint
|
|
1225
|
+
* for the first available map. Also returns the map(s) used for the
|
|
1226
|
+
* operation. Web only.
|
|
1227
|
+
*
|
|
1228
|
+
* @webOnly
|
|
1229
|
+
*/
|
|
1230
|
+
get getViewpoint(): Operation<Maps | void, GetViewpointResult>;
|
|
1231
|
+
/**
|
|
1232
|
+
* If a map extension ID is specified, returns the spatial reference for
|
|
1233
|
+
* that map. If no map extension ID is specified, returns the spatial
|
|
1234
|
+
* reference of the first available map.
|
|
1235
|
+
*/
|
|
1236
|
+
get getSpatialReference(): Operation<Maps | void, SpatialReference>;
|
|
1237
|
+
/**
|
|
1238
|
+
* Returns the point at the center of the visible map area. Accounts for
|
|
1239
|
+
* panels displaying overtop of the map. Mobile only.
|
|
1240
|
+
*
|
|
1241
|
+
* @mobileOnly
|
|
1242
|
+
*/
|
|
1243
|
+
get getVisibleCenter(): Operation<HasMaps, Point>;
|
|
1244
|
+
/**
|
|
1245
|
+
* Hides the map. Mobile only.
|
|
1246
|
+
*
|
|
1247
|
+
* @mobileOnly
|
|
1248
|
+
*/
|
|
1249
|
+
get hide(): Operation<HideMapArgs, boolean>;
|
|
1250
|
+
/**
|
|
1251
|
+
* Shows the map if it is hidden. Mobile only.
|
|
1252
|
+
*
|
|
1253
|
+
* @mobileOnly
|
|
1254
|
+
*/
|
|
1255
|
+
get show(): Operation<HasMaps, boolean>;
|
|
1256
|
+
/**
|
|
1257
|
+
* Enables sketching on a map. Mobile only.
|
|
1258
|
+
*
|
|
1259
|
+
* @mobileOnly
|
|
1260
|
+
*/
|
|
1261
|
+
get startSketch(): Operation<StartSketchArgs, Geometry>;
|
|
1262
|
+
/**
|
|
1263
|
+
* Stops sketching on the map. Mobile only.
|
|
1264
|
+
*
|
|
1265
|
+
* @mobileOnly
|
|
1266
|
+
*/
|
|
1267
|
+
get stopSketch(): Operation<HasMaps, Geometry>;
|
|
1268
|
+
/**
|
|
1269
|
+
* Returns the amount of the map that is currently covered by insets such as
|
|
1270
|
+
* the panel component. Mobile only.
|
|
1271
|
+
*
|
|
1272
|
+
* @mobileOnly
|
|
1273
|
+
*/
|
|
1274
|
+
get getViewInsets(): Operation<HasMaps, GetViewInsetsArgs>;
|
|
1275
|
+
}
|