@conterra/ct-mapapps-typings 4.19.3-next.20250627112807 → 4.19.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. package/agssearch/package.json +1 -1
  2. package/apprt/package.json +1 -1
  3. package/apprt-binding/package.json +1 -1
  4. package/apprt-core/Observable.d.ts +55 -0
  5. package/apprt-core/Types.d.ts +1 -1
  6. package/apprt-core/package.json +1 -1
  7. package/apprt-dom/package.json +1 -1
  8. package/apprt-fetch/package.json +1 -1
  9. package/apprt-request/package.json +1 -1
  10. package/apprt-streams/package.json +1 -1
  11. package/apprt-tokens/package.json +1 -1
  12. package/apprt-vue/package.json +1 -1
  13. package/apprt-vuetify/package.json +1 -1
  14. package/coordinatetransformer/package.json +1 -1
  15. package/ct/api/omnisearch/ResultHandler.d.ts +3 -0
  16. package/ct/api/omnisearch/Store.d.ts +3 -0
  17. package/ct/package.json +1 -1
  18. package/ct/ui/controls/mobile/DropDownMenu.d.ts +3 -0
  19. package/dataform/package.json +1 -1
  20. package/dataview/package.json +1 -1
  21. package/domains-system/package.json +1 -1
  22. package/editing/package.json +1 -1
  23. package/esri-widgets/package.json +1 -1
  24. package/geojson/package.json +1 -1
  25. package/geometryservice/package.json +1 -1
  26. package/graphics/package.json +1 -1
  27. package/highlights/package.json +1 -1
  28. package/integration-map/package.json +1 -1
  29. package/managementlayout/package.json +1 -1
  30. package/map-actions/package.json +1 -1
  31. package/map-basemaps-api/package.json +1 -1
  32. package/map-config-api/package.json +1 -1
  33. package/map-init/package.json +1 -1
  34. package/map-widget/package.json +1 -1
  35. package/mapdraw-api/package.json +1 -1
  36. package/mapnavigation/package.json +1 -1
  37. package/maptips/package.json +1 -1
  38. package/measurement-2d/package.json +1 -1
  39. package/measurement-3d/package.json +1 -1
  40. package/omnisearch/ActionsHandler.d.ts +9 -0
  41. package/omnisearch/DrawHandler.d.ts +9 -0
  42. package/omnisearch/DropDownMenu.d.ts +3 -0
  43. package/omnisearch/OmniSearchFactory.d.ts +3 -0
  44. package/omnisearch/OmniSearchModel.d.ts +3 -0
  45. package/omnisearch/RadioButton.d.ts +3 -0
  46. package/omnisearch/ResultCommand.d.ts +9 -0
  47. package/omnisearch/SearchUI.d.ts +3 -0
  48. package/omnisearch/SettingsWidget.d.ts +3 -0
  49. package/omnisearch/ZoomHandler.d.ts +8 -0
  50. package/omnisearch/package.json +5 -0
  51. package/package.json +1 -1
  52. package/parametermanager/package.json +1 -1
  53. package/popups/package.json +1 -1
  54. package/portal-security/package.json +1 -1
  55. package/result-api/package.json +1 -1
  56. package/resultcenter/ActionController.d.ts +3 -0
  57. package/resultcenter/BaseCommand.d.ts +3 -0
  58. package/resultcenter/DataModel.d.ts +3 -0
  59. package/resultcenter/DataModelBroadcaster.d.ts +3 -0
  60. package/resultcenter/DataModelMapController.d.ts +25 -0
  61. package/resultcenter/DataViewController.d.ts +3 -0
  62. package/resultcenter/DataViewStore.d.ts +3 -0
  63. package/resultcenter/ExportResultsCommand.d.ts +12 -0
  64. package/resultcenter/FeatureMapVisualizer.d.ts +35 -0
  65. package/resultcenter/GraphicResolverFactory.d.ts +15 -0
  66. package/resultcenter/OpenPopupService.d.ts +5 -0
  67. package/resultcenter/PostfixAttributeTableLookupStrategy.d.ts +3 -0
  68. package/resultcenter/RemoveResultsCommand.d.ts +6 -0
  69. package/resultcenter/RestrictQueriesToView.d.ts +3 -0
  70. package/resultcenter/ResultcenterToolRuleProcessor.d.ts +3 -0
  71. package/resultcenter/SearchStoreHandler.d.ts +8 -0
  72. package/resultcenter/SelectAllResultsCommand.d.ts +11 -0
  73. package/resultcenter/StoreEventReceiver.d.ts +3 -0
  74. package/resultcenter/StoreRegistration.d.ts +3 -0
  75. package/resultcenter/TriggerShowResultCenter.d.ts +3 -0
  76. package/resultcenter/VisualizationLayerResolver.d.ts +13 -0
  77. package/resultcenter/package.json +5 -0
  78. package/search-api/api.d.ts +2 -16
  79. package/search-api/package.json +1 -1
  80. package/search-ui/package.json +1 -1
  81. package/selection-resultcenter/CachingStore.d.ts +229 -0
  82. package/selection-resultcenter/MemoryStore.d.ts +10 -0
  83. package/selection-resultcenter/package.json +5 -0
  84. package/selection-services/package.json +1 -1
  85. package/store-api/package.json +1 -1
  86. package/system/package.json +1 -1
  87. package/templatelayout/package.json +1 -1
  88. package/test-utils/package.json +1 -1
  89. package/theme-tester/package.json +1 -1
  90. package/toc/package.json +1 -1
  91. package/toolrules/package.json +1 -1
  92. package/vuetify-component-overview/package.json +1 -1
  93. package/windowmanager/package.json +1 -1
  94. package/wizard/package.json +1 -1
  95. package/coordinateconversion/api.d.ts +0 -181
  96. package/coordinateconversion/package.json +0 -5
@@ -0,0 +1,8 @@
1
+ declare function _default(): {
2
+ showData(event: any): void;
3
+ clearData(event: any): void;
4
+ handleDataSourceUpdate(event: any): void;
5
+ deactivate(): void;
6
+ };
7
+
8
+ export { _default as default };
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Base class for select all command of result center.
3
+ */
4
+ declare class SelectAllResultsCommand {
5
+ deactivate(): void;
6
+ _selected: boolean | null | undefined;
7
+ selectAll(): void;
8
+ handleDataSourceChanged(): void;
9
+ }
10
+
11
+ export { SelectAllResultsCommand as default };
@@ -0,0 +1,3 @@
1
+ declare const _default: any;
2
+
3
+ export { _default as default };
@@ -0,0 +1,3 @@
1
+ declare const _default: any;
2
+
3
+ export { _default as default };
@@ -0,0 +1,3 @@
1
+ declare const _default: any;
2
+
3
+ export { _default as default };
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Helper of FeatureMapVisualizer to ensure that graphics rendered to special layer.
3
+ */
4
+ declare class VisualizationLayerResolver {
5
+ constructor(layerId: any, layerTitle: any);
6
+ layerId: any;
7
+ layerTitle: any;
8
+ resolve(mapWidgetModel: any): any;
9
+ remove(): void;
10
+ #private;
11
+ }
12
+
13
+ export { VisualizationLayerResolver as default };
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "resultcenter",
3
+ "version": "4.19.3",
4
+ "types": ""
5
+ }
@@ -50,15 +50,6 @@ interface SearchOptions {
50
50
  * The default value is `15`.
51
51
  */
52
52
  count?: number;
53
- /**
54
- * Whether to request the number of total results from the queries stores.
55
- *
56
- * This is true by default for backwards compatibility reasons.
57
- * Set this to `false` to skip requesting the total result count.
58
- *
59
- * See also {@link ResultSet.total}.
60
- */
61
- queryTotal?: boolean;
62
53
  /**
63
54
  * An optional array of map action IDs.
64
55
  * The associated map actions are triggered when an item is selected (see {@link ResultItem.select}).
@@ -122,13 +113,8 @@ interface ResultGroup {
122
113
  interface ResultSet {
123
114
  /** Result items, up to the requested amount. */
124
115
  readonly items: ResultItem[];
125
- /**
126
- * Total number of available results.
127
- *
128
- * This is present if the `queryTotal` option is set to `true` (the default).
129
- * This is always undefined if `queryTotal` is set to `false`.
130
- */
131
- readonly total: number | undefined;
116
+ /** Total number of available results */
117
+ readonly total: number;
132
118
  /**
133
119
  * Selects multiple items at once.
134
120
  * The items must belong to this result set (from `this.items`).
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "search-api",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "search-ui",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -0,0 +1,229 @@
1
+ import * as store_api_api from 'store-api/api';
2
+
3
+ /**
4
+ * The methods of this interface are available when a Promise
5
+ * has been augmented using the `trackState` function.
6
+ */
7
+ interface StateQueryable {
8
+ /** Returns true if the promise is settled, i.e. if it is no longer pending. */
9
+ isSettled(): boolean;
10
+ /** Returns true if the promise is fulfilled, i.e. if it has a success value. */
11
+ isFulfilled(): boolean;
12
+ /** Returns true if the promise is rejected, i.e. if it contains an error. */
13
+ isRejected(): boolean;
14
+ /** Returns true if the promise was cancelled before it was able to complete. */
15
+ isCancelled(): boolean;
16
+ }
17
+ type State = "pending" | "fulfilled" | "rejected" | "cancelled";
18
+ declare const PROMISE: unique symbol;
19
+ declare const STATE: unique symbol;
20
+ declare const PRIVATE_CONSTRUCTOR_TAG: unique symbol;
21
+ /**
22
+ * Wrapper of global.Promise class.
23
+ * Read more about [Promises](./PROMISES.md).
24
+ *
25
+ * @see https://developer.mozilla.org/de/docs/Web/JavaScript/Reference/Global_Objects/Promise
26
+ */
27
+ declare class ExtendedPromise<T> implements Promise<T> {
28
+ private [PROMISE];
29
+ private [STATE]?;
30
+ /**
31
+ * Creates Promise instances.
32
+ * @param executor defined as (resolve,reject)=> \{\}
33
+ * @example
34
+ * ```ts
35
+ * new Promise((resolve, reject)=>{
36
+ * ...
37
+ * });
38
+ * ```
39
+ */
40
+ constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void);
41
+ /**
42
+ * Internal constructor. Do not call.
43
+ */
44
+ constructor(promise: PromiseLike<T> | LegacyDojoDeferred, state: State | undefined, tag: typeof PRIVATE_CONSTRUCTOR_TAG);
45
+ /** Creates a new resolved promise */
46
+ static resolve(): ExtendedPromise<void>;
47
+ /**
48
+ * Creates a new resolved promise with the given value
49
+ * @param value result object.
50
+ * @returns a promise in fulfilled state.
51
+ */
52
+ static resolve<T>(value: T): ExtendedPromise<T>;
53
+ /**
54
+ * @param reason The reason the promise was rejected.
55
+ * @returns a promise in rejected state.
56
+ */
57
+ static reject<T = never>(reason?: any): ExtendedPromise<T>;
58
+ /**
59
+ * Creates promise which fulfills if all other promises are fulfilled.
60
+ * Or rejects if one of the promises rejects.
61
+ *
62
+ * @param iterable Iterable of Promise instances
63
+ */
64
+ static all<T extends readonly unknown[] | []>(iterable: T): ExtendedPromise<{
65
+ -readonly [P in keyof T]: Awaited<T[P]>;
66
+ }>;
67
+ /**
68
+ * Creates promise which fulfills if one of the other promises fulfills.
69
+ * Or rejects if one of the promises rejects.
70
+ *
71
+ * @param iterable Iterable of Promise instances
72
+ */
73
+ static race<T>(iterable: Iterable<T>): ExtendedPromise<T extends PromiseLike<infer U> ? U : T>;
74
+ /**
75
+ * Creates promise which fulfills if one of the other promises fulfills.
76
+ * Or rejects if one of the promises rejects.
77
+ *
78
+ * @param iterable Iterable of Promise instances
79
+ */
80
+ static race<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
81
+ /**
82
+ * Creates a promise that resolves after all of the given promises have either fulfilled or rejected,
83
+ * with an array of objects that each describes the outcome of each promise.
84
+ *
85
+ * @param iterable Iterable of Promise instances
86
+ */
87
+ static allSettled<T>(iterable: Iterable<T | PromiseLike<T>>): ExtendedPromise<PromiseSettledResult<Awaited<T>>[]>;
88
+ /**
89
+ * Promise.any() takes an iterable of Promise objects and, as soon as one of the promises in the iterable fulfills,
90
+ * returns a single promise that resolves with the value from that promise.
91
+ * If no promises in the iterable fulfill (if all of the given promises are rejected),
92
+ * then the returned promise is rejected with an AggregateError,
93
+ * Essentially, this method is the opposite of Promise.all().
94
+ *
95
+ * @param iterable Iterable of Promise instances
96
+ */
97
+ static any<T>(iterable: (T | PromiseLike<T>)[] | Iterable<T | PromiseLike<T>>): ExtendedPromise<T>;
98
+ /**
99
+ * Produces an object with a promise along with its resolution and rejection functions.
100
+ * Allows to resolve/reject the promise manually after creating it.
101
+ *
102
+ * @example
103
+ * ```ts
104
+ * const { promise, resolve, reject } = Promise.withResolvers();
105
+ * ```
106
+ * @returns {{ promise, resolve, reject }}
107
+ */
108
+ static withResolvers<T>(): {
109
+ resolve: (value: T | PromiseLike<T>) => void;
110
+ reject: (reason?: unknown) => void;
111
+ promise: ExtendedPromise<T>;
112
+ };
113
+ /**
114
+ * This method tests if a given object is a promise.
115
+ * The algorithm will return true for:
116
+ * * apprt-core/Promise
117
+ * * global Promise
118
+ * * dojo/Deferred
119
+ * * dojo/Deferred.promise
120
+ *
121
+ * Note: Because of support for dojo/Deferred any object with a
122
+ * 'then', 'isResolved' and 'isRejected' method is detected as a promise.
123
+ *
124
+ * @param candidate a potential promise.
125
+ * @returns true if candidate is a promise.
126
+ */
127
+ static isPromise(candidate: any): candidate is PromiseLike<unknown>;
128
+ /**
129
+ * Wraps e.g. dojo/Deferred or native Promise to this Promise class.
130
+ * @returns a promise
131
+ */
132
+ static wrap<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T>;
133
+ /**
134
+ * Augments the given Promise with new state lookup functions.
135
+ */
136
+ static trackState<T>(promise: PromiseLike<T> | LegacyDojoDeferred): ExtendedPromise<T> & StateQueryable;
137
+ /**
138
+ * Registers success and/or error handlers.
139
+ * @param success called when the promise resolves
140
+ * @param failure called when the promise rejects
141
+ */
142
+ then<TResult1 = T, TResult2 = never>(success?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, failure?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): ExtendedPromise<TResult1 | TResult2>;
143
+ /**
144
+ * Registers an error handler.
145
+ * @param failure called when the promise rejects
146
+ */
147
+ catch<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
148
+ /**
149
+ * Registers an error handler. Which is not called if the error is a Cancel instance.
150
+ * @param failure called when the promise rejects
151
+ */
152
+ else<TResult = never>(failure?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): ExtendedPromise<T | TResult>;
153
+ /**
154
+ * Registers a handler, which is called in success or error state.
155
+ * But the handler is not able to change the result state!
156
+ * @param handler function invoked regardless of success or error
157
+ */
158
+ finally(handler?: (() => void) | undefined | null): ExtendedPromise<T>;
159
+ /**
160
+ * @returns this instance, augmented with augmented with:
161
+ *
162
+ * * isFulfilled()
163
+ * * isRejected()
164
+ * * isCancelled()
165
+ * * isSettled()
166
+ */
167
+ trackState(): ExtendedPromise<T> & StateQueryable;
168
+ get [Symbol.toStringTag](): string;
169
+ }
170
+
171
+ interface LegacyDojoDeferred {
172
+ promise: any;
173
+ isResolved(): boolean;
174
+ isRejected(): boolean;
175
+ isFulfilled(): boolean;
176
+ isCanceled(): boolean;
177
+ progress(update: any, strict?: boolean): any;
178
+ resolve(value?: any, strict?: boolean): any;
179
+ reject(error?: any, strict?: boolean): any;
180
+ then(callback?: any, errback?: any, progback?: any): any;
181
+ cancel(reason?: any, strict?: boolean): any;
182
+ toString(): string;
183
+ }
184
+
185
+ /**
186
+ * This class provides a caching store. All used field values will be cached in a memory store.
187
+ */
188
+ declare class CachingStore {
189
+ /**
190
+ * Defines if geometry will be cached
191
+ */
192
+ constructor(args: any);
193
+ maxFeaturesLimit: number;
194
+ initialQuery: any;
195
+ querySequenz: any;
196
+ idProperty: any;
197
+ _cache: any[];
198
+ _geometryCache: any;
199
+ idList: any[];
200
+ deactivate(): void;
201
+ getInitialQuery(): any;
202
+ _addItemToCache(item: any, offset: any): void;
203
+ _updateGeometryCache(item: any, offset: any): void;
204
+ getMetadata(object: any): any;
205
+ getIdentity(object: any): any;
206
+ _getAllMasterStoreFields(): ExtendedPromise<{}>;
207
+ _getItems(itemIds: any, opts: any): Promise<any[]>;
208
+ _buildQuery(itemIds: any): {};
209
+ _isGeometryRequired(options: any, defaultRequired: any): Any;
210
+ _getGeometryFromCache(id: any, offset: any): any;
211
+ _isSpatialQuery(query: any): boolean;
212
+ _getItemsFromCache(query: any, options?: {}): store_api_api.ResultItems<Readonly<Record<string, any>>>;
213
+ _getGeometryForItems(items: any, options: any): ExtendedPromise<any>;
214
+ _getItemsForQuery(query: any, options: any): ExtendedPromise<any[]>;
215
+ query(query: any, options: any): store_api_api.ResultItems<{}>;
216
+ _synchronizedQueryOnCache(query: any, opts: any): any;
217
+ querySequence: any;
218
+ _queryOnCache(query: any, opts: any): ExtendedPromise<any>;
219
+ _geometryMissingInCachedItems(offset: any, query: any, opts: any): boolean;
220
+ _getOffset(options: any): Any;
221
+ _checkIfCacheIsPopulated(): boolean;
222
+ _populateCache(): any;
223
+ _fetchCache: any;
224
+ get(id: any, options: any): any;
225
+ remove(id: any): boolean;
226
+ invalidate(id: any): void;
227
+ }
228
+
229
+ export { CachingStore as default };
@@ -0,0 +1,10 @@
1
+ import { AsyncWritableInMemoryStore } from 'store-api/InMemoryStore';
2
+
3
+ declare class MemoryStore extends AsyncWritableInMemoryStore<any, any> {
4
+ constructor(opts: any);
5
+ masterStore: any;
6
+ idList: any;
7
+ getMetadata(): Promise<any>;
8
+ }
9
+
10
+ export { MemoryStore };
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "selection-resultcenter",
3
+ "version": "4.19.3",
4
+ "types": ""
5
+ }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "selection-services",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "store-api",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "system",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "templatelayout",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "test-utils",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "theme-tester",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
package/toc/package.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "toc",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "toolrules",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "vuetify-component-overview",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "windowmanager",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "wizard",
3
- "version": "4.19.3-SNAPSHOT",
3
+ "version": "4.19.3",
4
4
  "types": ""
5
5
  }
@@ -1,181 +0,0 @@
1
- import { SpatialReference, Point } from 'esri/geometry';
2
-
3
- /**
4
- * Parsing succeeded and returned a valid value.
5
- */
6
- interface ParseSuccess<T> {
7
- kind: "success";
8
- value: T;
9
- }
10
- /**
11
- * Parsing resulted in an error.
12
- */
13
- interface ParseError {
14
- kind: "error";
15
- /**
16
- * Human readable error message.
17
- * This message may be presented to the user.
18
- */
19
- message?: string;
20
- }
21
- /**
22
- * The result of parsing inputs.
23
- */
24
- type ParseResult<T> = ParseSuccess<T> | ParseError;
25
- /**
26
- * Implements a format for coordinate conversions.
27
- *
28
- * You can extend the builtin set of formats by providing a service with `"coordinateconversion.SegmentedFormat"`.
29
- */
30
- interface SegmentedFormat {
31
- /**
32
- * Unique id of this format.
33
- */
34
- readonly id: string;
35
- /**
36
- * Human readable label of this format.
37
- */
38
- readonly label: string;
39
- /**
40
- * Input segments required by the format, for example `x` and `y` coordinates.
41
- * The coordinate conversion widget shows one input field for each segment.
42
- */
43
- readonly segments: CoordinateSegment[];
44
- /**
45
- * When specified, points will be projected to this spatial reference before being passed to {@link pointToSegments}.
46
- *
47
- * If this is not specified, you will receive the point in the current spatial reference of the view, and
48
- * you will have to perform any necessary projections yourself.
49
- */
50
- readonly spatialReference?: SpatialReference;
51
- /**
52
- * Renders a point to _segment_ values.
53
- * The returned record is indexed by segment ids and contains a string for each segment.
54
- *
55
- * The output of this function should be compatible with {@link segmentsToPoint}.
56
- *
57
- * Example:
58
- *
59
- * ```js
60
- * const point = ...;
61
- * const segments = format.pointToSegments(point);
62
- * // segments == { x: "...", y: "..." }
63
- * ```
64
- */
65
- pointToSegments(point: Point): Promise<Record<string, string>>;
66
- /**
67
- * Formats a set of _segment_ values to a human readable string.
68
- * This combines the segment values to a final display string, including separating characters (like ',' or ' ')
69
- * and units (like '°' and '"').
70
- *
71
- * The `segments` parameter can be assumed to contain valid strings: either
72
- * - user input validated by {@link CoordinateSegment.validate} or
73
- * - segment values generated by {@link pointToSegments}.
74
- *
75
- * The value returned here should be compatible with {@link stringToSegments}.
76
- *
77
- * Example:
78
- *
79
- * ```js
80
- * const segments = { x: "1", y: "2" }
81
- * const output = format.segmentsToString(segments);
82
- * // output == "1°, 2°"
83
- * ``
84
- */
85
- segmentsToString(segments: Record<string, string>): string;
86
- /**
87
- * Splits a human readable coordinates string (like returned by {@link segmentsToString}) into its input segment.
88
- *
89
- * For example:
90
- *
91
- * ```js
92
- * const input = "123.4 567.8";
93
- * const segments = format.stringToSegments(input).value; // assumes success
94
- * // segments == { x: "123.4", y: "567.8" };
95
- * ```
96
- */
97
- stringToSegments(input: string): ParseResult<Record<string, string>>;
98
- /**
99
- * Parses a set of (validated) segment values into a `Point`.
100
- * This can be used, for example, to place a marker on the map.
101
- *
102
- * Example:
103
- *
104
- * ```js
105
- * const segments = { x: "1", y: "2" }
106
- * const point = await format.segmentsToPoint(segments).value; // assumes success
107
- * // point == { x: 1234, y: 5678, spatialReference: { ... }}
108
- * ```
109
- */
110
- segmentsToPoint(segments: Record<string, string>): Promise<ParseResult<Point>>;
111
- }
112
- /**
113
- * A coordinate segment within a {@link SegmentedFormat}.
114
- */
115
- interface CoordinateSegment {
116
- /**
117
- * Id of this segment.
118
- *
119
- * This should be unique within the context of its format.
120
- */
121
- id: string;
122
- /**
123
- * Human readable label for this coordinate segment (e.g. "Latitude").
124
- */
125
- label: string;
126
- /**
127
- * Example for this segment, like '51° 57' 40"N'
128
- */
129
- example?: string;
130
- /**
131
- * A prefix value that will be shown as part of the input field for this coordinate segment.
132
- *
133
- * This is a display-only field for strings that do not need to be typed by the user (such as "°").
134
- */
135
- prefix?: string;
136
- /**
137
- * A suffix value that will be shown as part of the input field for this coordinate segment.
138
- *
139
- * This is a display-only field for strings that do not need to be typed by the user (such as "°").
140
- */
141
- suffix?: string;
142
- /**
143
- * Validates an input string for this coordinate segment.
144
- * `input` is the (trimmed) text typed by the user.
145
- *
146
- * This function should return `true` if the input is valid,
147
- * or an error message otherwise.
148
- *
149
- * `validate()` usually only performs text based validation (e.g. regular expressions).
150
- * Parsing the actual input string (using {@link SegmentedFormat.segmentsToPoint}) can return additional errors.
151
- *
152
- * Only valid inputs will be passed to {@link SegmentedFormat.segmentsToPoint}.
153
- */
154
- validate(input: string): true | false | ParseError;
155
- }
156
- /**
157
- * A model that provides access to the current state of the coordinate conversion widget.
158
- * Properties and methods are designed to be used together with the Reactivity API.
159
- *
160
- * It is available as service `coordinateconversion.Model`.
161
- */
162
- interface CoordinateConversionModel {
163
- /**
164
- * True if the widget is currently active.
165
- */
166
- readonly active: boolean;
167
- /**
168
- * The current marker location, if any.
169
- * This value represents explicit location inputs and also locations from mouse movements.
170
- */
171
- readonly currentLocation: Point | undefined;
172
- /**
173
- * The current marker location, if any.
174
- *
175
- * This value represents explicit location inputs only, i.e. if the user clicked on the map (not just moving the mouse)
176
- * or confirmed the input form.
177
- */
178
- readonly confirmedLocation: Point | undefined;
179
- }
180
-
181
- export type { CoordinateConversionModel, CoordinateSegment, ParseError, ParseResult, ParseSuccess, SegmentedFormat };
@@ -1,5 +0,0 @@
1
- {
2
- "name": "coordinateconversion",
3
- "version": "4.19.3-SNAPSHOT",
4
- "types": ""
5
- }