jmapcloud-ng-types 2.0.4 → 2.0.6-qa.3

package/index.ts

@@ -127,6 +127,8 @@ export interface JAppPrintState {
   isNorthArrowVisible: boolean
   isScaleVisible: boolean
   isLegend: boolean
+  customContent: HTMLElement | null
+  customContentWidthInPercent: number
   legendTitle: string
   legendPosition: JAPP_PRINT_LEGEND_POSITION
   filterList: any[]
@@ -350,6 +352,8 @@ export interface JAppPrintService {
   takeCapture(returnAsScreenCaptureResult?: boolean, customRatioWidth?: number, customRatioHeight?: number): Promise<void | JAppPrintCaptureResult>
   setLegendVisibility(isVisible: boolean): void
   isLegendVisible(): boolean
+  setCustomContentWidthInPercent(percent: number): void
+  setCustomContent(html: HTMLElement | null): void
 }
 
 export interface JAppLayerService {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jmapcloud-ng-types",
-  "version": "2.0.4",
+  "version": "2.0.6-qa.3",
   "description": "JMap Cloud specific version of JMap Cloud NG types and interfaces",
   "main": "src/app.ts",
   "types": "ambient.d.ts",

package/public/app.d.ts

@@ -25,11 +25,11 @@ declare global {
       /**
        * **JMap.Application.getVersion**
        *
-       * Returns the application build version.
+       * Returns the JMap Cloud NG npm package version.
        *
        * @example
        * ```ts
-       * // return the build version, for example "1.0.1"
+       * // return the package version, for example "2.0.5-qa.10"
        * JMap.Application.getVersion()
        * ```
        */
@@ -38,13 +38,11 @@ declare global {
       /**
        * **JMap.Application.getApiVersion**
        *
-       * Returns the application API (Typescript interfaces) version.
-       *
-       * For the same API version, multiple implementation versions can exist.
+       * Returns the JMap Cloud NG npm package version.
        *
        * @example
        * ```ts
-       * // return the build version, for example "1.0.1"
+       * // return the package version, for example "2.0.5-qa.10"
        * JMap.Application.getApiVersion()
        * ```
        */
@@ -2338,6 +2336,50 @@ declare global {
          */
         function setLegendVisibility(isVisible: boolean): void
 
+        /**
+         * **JMap.Application.Print.setCustomContentWidthInPercent**
+         *
+         * Sets the width used by the custom content area as a percentage of the available width left by the print legend.
+         *
+         * The value must be between 0 and 100.
+         *
+         * @throws if percent is not a finite number between 0 and 100
+         * @param percent The percentage of the available width used by the custom content area
+         * @example
+         * ```ts
+         * // Use 40 percent of the available width left by the print legend
+         * JMap.Application.Print.setCustomContentWidthInPercent(40)
+         * ```
+         */
+        function setCustomContentWidthInPercent(percent: number): void
+
+        /**
+         * **JMap.Application.Print.setCustomContent**
+         *
+         * Sets the custom HTML content displayed in the print layout, in the available area left by the print legend.
+         *
+         * The custom content is displayed top-right aligned. Pass null to clear the custom content.
+         *
+         * @throws if html is not an HTMLElement or null
+         * @param html The HTML element to display in the print layout, or null to clear it
+         * @example
+         * ```ts
+         * // Add custom content
+         * const content = document.createElement("div")
+         * content.innerHTML = `
+         *   <svg width="120" height="60" viewBox="0 0 120 60">
+         *     <rect width="120" height="60" fill="white" />
+         *     <circle cx="30" cy="30" r="20" fill="red" />
+         *   </svg>
+         * `
+         * JMap.Application.Print.setCustomContent(content)
+         *
+         * // Clear custom content
+         * JMap.Application.Print.setCustomContent(null)
+         * ```
+         */
+        function setCustomContent(html: HTMLElement | null): void
+
         /**
          * **JMap.Application.Print.getAllPaperFormats**
          *