jmapcloud-ng-core-types 1.0.15 → 1.0.17

package/index.ts

@@ -855,6 +855,8 @@ export interface JProjectService {
   isChangeDisabled(): boolean
   setChangeEnabled(): void
   setChangeDisabled(): void
+  getElevationAtLocation(location: JLocation): Promise<number | null>
+  hasTerrain(): boolean
 }
 
 export interface JLayerService {

package/package.json

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

package/public/core.d.ts

@@ -6055,6 +6055,50 @@ declare namespace JMap {
      * ```
      */
     function setChangeDisabled(): void
+
+    /**
+     * **JMap.Project.getElevationAtLocation**
+     *
+     * Gets the elevation of the Terrain associated with the project for the given location.
+     *
+     * @throws if location is invalid or if there is no terrain associated with the project.
+     * @param location
+     * @return the elevation at the given location, or null if no elevation data is available at that location.
+     * @example
+     * ```ts
+     * // get the elevation
+     * if (JMap.Project.hasTerrain()) {
+     *    JMap.Project.getElevationAtLocation({x:-73.591205, y:45.505216})
+     *      .then(elevation => {
+     *          if(elevation !== null){
+     *            console.log(`Elevation at x:-73.591205, y:45.505216 is ${elevation}`)
+     *          }else{
+     *            console.log("No elevation data available for location x:-73.591205, y:45.505216")
+     *          }
+     *      })
+     * }else{
+     *    console.log("there is no terrain associated with this project.")
+     * }
+     * ```
+     */
+    function getElevationAtLocation(location: JLocation): Promise<number | null>
+
+    /**
+     * **JMap.Project.hasTerrain**
+     *
+     * Returns true if a project is loaded and if a terrain is associated with the project, false otherwise
+     *
+     * @example
+     * ```ts
+     * // get the elevation
+     * if (JMap.Project.hasTerrain()) {
+     *    console.log("A terrain is associated with this project.")
+     * }else{
+     *    console.log("there is no project loaded, or no terrain associated with this project.")
+     * }
+     * ```
+     */
+    function hasTerrain(): boolean
   }
 
   /**
@@ -8887,7 +8931,7 @@ declare namespace JMap {
         /**
          * ***JMap.Event.Map.on.mapLoad***
          *
-         * This event is triggered when a layer is deleted.
+         * This event is triggered when the map is created and ready.
          *
          * @param listenerId Your listener id (must be unique for all map events)
          * @param fn Your listener function

package/public/jmap/project.d.ts

@@ -34,7 +34,6 @@ declare interface JProject {
   initialRotation: number
   colorSelection: string
   colorBackground: string
-  terrainRasterDataSourceId?: JId
   terrain?: JTerrainSpecification
   initialExtent: JBounds | null
   minimumVisibleZoom: number
@@ -53,6 +52,7 @@ declare interface JProject {
 }
 
 declare interface JTerrainSpecification {
+  dataSourceId?: string
   terrainExaggeration?: number
   hillshadeExaggeration?: number
   hillshadeIlluminationDirection?: number