jmapcloud-ng-types 1.0.12 → 1.0.14

package/index.ts

@@ -357,7 +357,11 @@ export interface JAppPrintService {
   getFileType(): JAPP_PRINT_FILE_TYPES
   setHiResolution(isHiResolution: boolean): void
   getHiResolution(): boolean
-  takeCapture(returnAsScreenCaptureResult?: boolean): Promise<void | JAppPrintCaptureResult>
+  takeCapture(
+    returnAsScreenCaptureResult?: boolean,
+    customRatioWidth?: number,
+    customRatioHeight?: number
+  ): Promise<void | JAppPrintCaptureResult>
 }
 
 export interface JAppLayerService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "1.0.12",
+  "version": "1.0.14",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "scripts": {
@@ -23,7 +23,7 @@
   "homepage": "https://github.com/k2geospatial/jmapcloud-ng-types#readme",
   "devDependencies": {
     "@types/react": "^18.3.2",
-    "jmapcloud-ng-core-types": "1.0.10",
+    "jmapcloud-ng-core-types": "1.0.11",
     "maplibre-gl": "^4.3.1",
     "react": "^18.3.1",
     "typedoc": "^0.25.13"

package/public/app.d.ts

@@ -2273,7 +2273,6 @@ declare namespace JMap {
        *
        * Different sizes are available: "letter" | "legal" | "a3" | "a4".
        *
-       * @deprecated will be removed in the futur
        * @example
        * ```ts
        * // returns all available paper formats
@@ -2289,7 +2288,6 @@ declare namespace JMap {
        *
        * Technical method, you should not use it.
        *
-       * @deprecated will be removed in the futur
        * @throws if format is incorrect
        * @param format the paper format object or a {@link JAPP_PRINT_PAPER_SIZES}
        * @example
@@ -2305,7 +2303,6 @@ declare namespace JMap {
        *
        * Returns the active paper format.
        *
-       * @deprecated will be removed in the futur
        * @example
        * ```ts
        * // returns active paper format
@@ -2409,8 +2406,10 @@ declare namespace JMap {
        *
        * Builds a screen capture of the map and launches the download of the file, or returns the screen capture as a data url embeded in a {@link JAppPrintCaptureResult}
        * @param returnAsScreenCaptureResult if true, the method will resolve with a {@link JAppPrintCaptureResult} that you can use to embed the image in an HTML page, otherwise the method will resolve with no result
+       * @param customRatioWidth The custom ratio width. When both customRatioWidth and customRatioHeight are specified, the captured image will be using a custom paper format having the aspect ratio defined by the specified width/height. returnAsScreenCaptureResult must be set to "true" for this parameter to be taken into account
+       * @param customRatioHeight The custom ratio height. returnAsScreenCaptureResult must be set to "true" for this parameters to be taken into account
        *
-       * When passing `returnAsScreenCaptureResult = true`, The screen capture process will take into account all Print parameters defined in the Print panel, including page format, scale, North arrow, title, sub-title, etc, but with the following limitations:
+       * When passing `returnAsScreenCaptureResult = true`, the screen capture process will take into account all Print parameters defined in the Print panel, including page format, scale, North arrow, title, sub-title, etc, but with the following limitations:
        *
        * * the image format returned will always be PNG
        * * If you want the Print panel overlays be present in the screen capture, you must programaticaly switch to the Print panel before calling JMap.Application.Print.takeCapture(true), otherwise only the map will be captured
@@ -2422,7 +2421,7 @@ declare namespace JMap {
        * JMap.Application.Print.takeCapture()
        *
        * // add an image to a document with the print result
-       * JMap.Application.Print.takeCapture(true).then(
+       * JMap.Application.Print.takeCapture(true, 400, 200).then(
        *    printCaptureResult => {
        *      const img = document.createElement("img")
        *      img.src = printCaptureResult.dataUrl
@@ -2437,7 +2436,11 @@ declare namespace JMap {
        * )
        * ```
        */
-      function takeCapture(returnAsScreenCaptureResult?: boolean): Promise<void | JAppPrintCaptureResult>
+      function takeCapture(
+        returnAsScreenCaptureResult?: boolean,
+        customRatioWidth?: number,
+        customRatioHeight?: number
+      ): Promise<void | JAppPrintCaptureResult>
     }
 
     /**

package/public/print.d.ts

@@ -10,7 +10,8 @@ declare const enum JAPP_PRINT_PAPER_SIZES {
   LETTER = "letter",
   LEGAL = "legal",
   A3 = "a3",
-  A4 = "a4"
+  A4 = "a4",
+  CUSTOM = "custom"
 }
 
 // ALL_APP_PRINT_LEGEND_POSITION in all-enum.ts