npm - jmapcloud-ng-core-types - Versions diffs - 2.0.10-qa.10 → 2.0.10-qa.12 - Mend

jmapcloud-ng-core-types 2.0.10-qa.10 → 2.0.10-qa.12

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 (3) hide show

package/package.json +1 -1
package/public/core.d.ts +11 -30
package/public/jmap/startup-options.d.ts +4 -29

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-core-types",
-  "version": "2.0.10-qa.10",
+  "version": "2.0.10-qa.12",
   "description": "JMap Cloud specific version of JMap Cloud NG Core types and interfaces",
   "main": "index.js",
   "types": "ambient.d.ts",

package/public/core.d.ts CHANGED Viewed

@@ -5897,18 +5897,17 @@ export namespace JMap {
     /**
      * **JMap.Project.getBase64ImageThumbnail**
      *
-     * Returns loaded JMap project base64 image thumbnail.
+     * Returns the active JMap project's base64 image preview.
      *
-     * When JMap Cloud NG Core lib is started, it doesn't load projects thumbnails, but you can load it
-     * by setting the startup option "loadAllProjectThumbnails" as true.
-     *
-     * If no thumbnail has been loaded it returns an empty string.
+     * Project preview thumbnails are not available on the JMap Cloud server yet, so this
+     * currently returns an empty string for most projects. It will return the real project
+     * preview once the server provides one.
      *
      * @throws If no project is loaded
      * @example
      * ```ts
-     * // returns the project initial extent if exists
-     * JMap.Project.getInitialExtent()
+     * // returns the project base64 image thumbnail if loaded
+     * JMap.Project.getBase64ImageThumbnail()
      * ```
      */
     function getBase64ImageThumbnail(): string
@@ -5975,31 +5974,13 @@ export namespace JMap {
     /**
      * **JMap.Project.loadAllProjectThumbnails**
      *
-     * Load all project thumbnails in the data store.
+     * Project preview thumbnails are not available on the JMap Cloud server, so this is a no-op
+     * that resolves immediately. Kept for API compatibility with on-premise JMap Server.
      *
-     * Default width is 348 and height 190.
+     * The `params` argument is ignored.
      *
-     * Image is a base 64 formatted string.
-     *
-     * @throws if params are not correct
-     * @param params width (0 < width < 1280) and height (0 < height < 720) for the thumbnails
-     * @example
-     * ```ts
-     * // Will load all projects thumbnail images
-     * JMap.Project
-     *    .loadAllProjectThumbnails({
-     *      width: 200,
-     *      height: 200
-     *    })
-     *    .then(() => console.info("All project images has been loaded"))
-     *    .catch(error => console.error("Cannot load project images"))
-     *
-     * // Then you can get current project thumnail like that
-     * const thumbnail = JMap.Project.getBase64ImageThumbnail()
-     *
-     * // Or you can get the project id=3 thumbnail like this
-     * const otherThumbnail = JMap.Project.getById(3).base64ImageThumbnail
-     * ```
+     * @deprecated Project thumbnails are not available on JMap Cloud; this is a no-op.
+     * @param params ignored on JMap Cloud
      */
     function loadAllProjectThumbnails(params?: JProjectLoadThumbnailsParams): Promise<void>
     /**

package/public/jmap/startup-options.d.ts CHANGED Viewed

@@ -123,37 +123,12 @@ export interface JCoreOptions {
    */
   onProjectsChange?(params: JProjectAllEventParams): void
   /**
-   * By default, project thumbnails are not loaded because they are only needed
-   * when the integration displays project choices.
+   * Project preview thumbnails are not available on the JMap Cloud server, so this option has
+   * no effect. The `base64ImageThumbnail` property of a project is always "" (empty string).
    *
-   * To load project thumbnails asynchronously, set `loadProjectThumbnails` to true.
+   * Kept for API compatibility with on-premise JMap Server.
    *
-   * NG will load project thumbnails into the `base64ImageThumbnail` property.
-   *
-   * The thumbnail is stored as a base64 string image, that you can use to set an img src attribute directly.
-   *
-   * For a project object, if thumbnail is not loaded, default value of its property "base64ImageThumbnail" is "" (empty string).
-   *
-   * ```html
-   * <html>
-   *   ...
-   *   <body>
-   *     <script type="text/javascript">
-   *       window.JMAP_OPTIONS = {
-   *         ...
-   *         loadProjectThumbnails: true
-   *       }
-   *     </script>
-   *     ...
-   *   </body>
-   * </html>
-   * ```
-   *
-   * Then you will be able to get a project and use its thumbnail  :
-   * ```javascript
-   * JMap.Project.getBase64ImageThumbnail() // return loaded project image, "" if no image loaded
-   * JMap.Project.getById(3).base64ImageThumbnail // return project id=3 image, "" if no image loaded
-   * ```
+   * @deprecated Project thumbnails are not available on JMap Cloud; this option has no effect.
    */
   loadProjectThumbnails?: boolean
   /**