jmapcloud-ng-core-types 1.0.3 → 1.0.4

package/index.ts

@@ -501,6 +501,8 @@ export interface JMapState {
   scaleControlPosition: JMAP_POSITIONS
   distanceUnit: JMAP_DISTANCE_UNITS
   isNavigationHistoryControlVisible: boolean
+  isTerrainAvailable: boolean
+  isTerrainActive: boolean
   isScaleControlVisible: boolean
   isMapRotationControlVisible: boolean
   isInfoControlVisible: boolean
@@ -691,6 +693,9 @@ export interface JMapService {
   getZoom(): number
   getMaplibreSourceIdByJMapLayerId(layerId: JId): string
   isScaleControlVisible(): boolean
+  isTerrainAvailable(): boolean
+  isTerrainActive(): boolean
+  setTerrainActive(active: boolean): void
   setScaleControlVisibility(isVisible: boolean, position?: JMAP_POSITIONS): void
   setScaleControlUnits(units: "imperial" | "metric" | "nautical"): void
   setScaleControlPosition(position: JMAP_POSITIONS): void

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "scripts": {

package/public/core.d.ts

@@ -3101,6 +3101,52 @@ declare namespace JMap {
      */
     function isScaleControlVisible(): boolean
 
+    /**
+     * ***JMap.Map.isTerrainAvailable***
+     *
+     * Returns true if the map is associated with a terrain.
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with a terrain
+     * JMap.Map.isTerrainAvailable()
+     * ```
+     */
+    function isTerrainAvailable(): boolean
+
+    /**
+     * ***JMap.Map.isTerrainActive***
+     *
+     * Returns true if the map is associated with an active terrain, false otherwise.
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with an active terrain, false otherwise
+     * JMap.Map.isTerrainActive()
+     * ```
+     */
+    function isTerrainActive(): boolean
+
+    /**
+     * ***JMap.Map.setTerrainActive***
+     *
+     * Returns true if the map is associated with a terrain.
+     *
+     * @param active whether to activate or deactivate the terrain
+     * @throws Error is no terrain is available
+     *
+     * @example ```ts
+     *
+     * // returns true if the map is associated with a terrain
+     * if(JMap.Map.isTerrainAvailable()){
+     *    JMap.Map.setTerrainActive(true)
+     * }else{
+     *    console.log("no terrain available")
+     * }
+     * ```
+     */
+    function setTerrainActive(active: boolean): void
+
     /**
      * ***JMap.Map.setScaleControlVisibility***
      *