jmapcloud-ng-types 1.0.44 → 1.0.46

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/index.ts CHANGED
@@ -7,6 +7,7 @@ export interface JAppState {
7
7
  selection: JAppSelectionState
8
8
  layer: JAppLayerState
9
9
  ui: JAppUiState
10
+ map: JAppMapState
10
11
  query: JAppQueryState
11
12
  print: JAppPrintState
12
13
  project: JAppProjectState
@@ -74,6 +75,11 @@ export interface JAppUiState {
74
75
  theme: { [key: string]: any }
75
76
  }
76
77
 
78
+ export interface JAppMapState {
79
+ simpleSearchControlVisible: boolean
80
+ geocodingControlVisible: boolean
81
+ }
82
+
77
83
  export interface JAppFormState {
78
84
  expandedSections: { [id: string]: boolean }
79
85
  }
@@ -277,6 +283,12 @@ export interface JApplicationUIService {
277
283
  setDark(isDark: boolean): void
278
284
  isDark(): boolean
279
285
  }
286
+ Map: {
287
+ isGeocodingControlVisible(): boolean
288
+ setGeocodingControlVisibility(isVisible: boolean): void
289
+ isSimpleSearchControlVisible(): boolean
290
+ setSimpleSearchControlVisibility(isVisible: boolean): void
291
+ }
280
292
  }
281
293
 
282
294
  export interface JAppEventService {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jmapcloud-ng-types",
3
- "version": "1.0.44",
3
+ "version": "1.0.46",
4
4
  "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
5
5
  "main": "src/app.ts",
6
6
  "scripts": {
@@ -23,7 +23,7 @@
23
23
  "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
24
24
  "devDependencies": {
25
25
  "@types/react": "^18.3.2",
26
- "jmapcloud-ng-core-types": "1.0.46",
26
+ "jmapcloud-ng-core-types": "1.0.48",
27
27
  "maplibre-gl": "^4.3.1",
28
28
  "react": "^18.3.1",
29
29
  "typedoc": "^0.25.13"
package/public/app.d.ts CHANGED
@@ -2070,6 +2070,72 @@ declare namespace JMap {
2070
2070
  */
2071
2071
  function getTitleMinHeightInPixel(): number
2072
2072
  }
2073
+ /**
2074
+ * **JMap.Application.UI.Map**
2075
+ *
2076
+ * You can manage the Map UI here.
2077
+ */
2078
+ namespace Map {
2079
+ /**
2080
+ * **JMap.Application.UI.Map.isGeocodingControlVisible**
2081
+ *
2082
+ * Returns true if the geocoding control is currently visible.
2083
+ *
2084
+ * @example
2085
+ * ```ts
2086
+ * // true or false
2087
+ * JMap.Application.UI.Map.isGeocodingControlVisible()
2088
+ * ```
2089
+ */
2090
+ function isGeocodingControlVisible(): boolean
2091
+
2092
+ /**
2093
+ * **JMap.Application.UI.Map.setGeocodingControlVisibility**
2094
+ *
2095
+ * Displays or hides the geocoding control.
2096
+ *
2097
+ * @param isVisible true to display, false to hide
2098
+ * @example
2099
+ * ```ts
2100
+ * // Display the geocoding control
2101
+ * JMap.Application.UI.Map.setGeocodingControlVisibility(true)
2102
+ *
2103
+ * // Hide the geocoding control
2104
+ * JMap.Application.UI.Map.setGeocodingControlVisibility(false)
2105
+ * ```
2106
+ */
2107
+ function setGeocodingControlVisibility(isVisible: boolean): void
2108
+
2109
+ /**
2110
+ * **JMap.Application.UI.Map.isSimpleSearchControlVisible**
2111
+ *
2112
+ * Returns true if the Simple Search control is currently visible.
2113
+ *
2114
+ * @example
2115
+ * ```ts
2116
+ * // true or false
2117
+ * JMap.Application.UI.Map.isSimpleSearchControlVisible()
2118
+ * ```
2119
+ */
2120
+ function isSimpleSearchControlVisible(): boolean
2121
+
2122
+ /**
2123
+ * **JMap.Application.UI.Map.setSimpleSearchControlVisibility**
2124
+ *
2125
+ * Displays or hides the Simple Search control.
2126
+ *
2127
+ * @param isVisible true to display, false to hide
2128
+ * @example
2129
+ * ```ts
2130
+ * // Display the Simple Search control
2131
+ * JMap.Application.UI.Map.setSimpleSearchControlVisibility(true)
2132
+ *
2133
+ * // Hide the Simple Search control
2134
+ * JMap.Application.UI.Map.setSimpleSearchControlVisibility(false)
2135
+ * ```
2136
+ */
2137
+ function setSimpleSearchControlVisibility(isVisible: boolean): void
2138
+ }
2073
2139
 
2074
2140
  /**
2075
2141
  * **JMap.Application.UI.Theme**
@@ -158,6 +158,54 @@ declare interface JApplicationOptions {
158
158
  */
159
159
  theme?: "dark" | "light"
160
160
 
161
+ /**
162
+ * By default the Simple Search control is visible.
163
+ *
164
+ * But if ***simpleSearchControlVisible*** is false, it will be hidden over the map.
165
+ *
166
+ * ```html
167
+ * <html>
168
+ * ...
169
+ * <body>
170
+ * <script type="text/javascript">
171
+ * window.JMAP_OPTIONS = {
172
+ * ...
173
+ * application: {
174
+ * simpleSearchControlVisible: false,
175
+ * }
176
+ * }
177
+ * </script>
178
+ * ...
179
+ * </body>
180
+ * </html>
181
+ * ```
182
+ */
183
+ simpleSearchControlVisible?: boolean
184
+
185
+ /**
186
+ * By default the Geocoding control is visible.
187
+ *
188
+ * But if ***geocodingControlVisible*** is false, it will be hidden over the map.
189
+ *
190
+ * ```html
191
+ * <html>
192
+ * ...
193
+ * <body>
194
+ * <script type="text/javascript">
195
+ * window.JMAP_OPTIONS = {
196
+ * ...
197
+ * application: {
198
+ * geocodingControlVisible: false,
199
+ * }
200
+ * }
201
+ * </script>
202
+ * ...
203
+ * </body>
204
+ * </html>
205
+ * ```
206
+ */
207
+ geocodingControlVisible?: boolean
208
+
161
209
  /**
162
210
  * By default the active panel (the one displayed), is the "layer" panel.
163
211
  *