@vidro/map-handler 1.3.14 → 2.0.0

package/README.md

@@ -1,6 +1,6 @@
 # Map Handler
 
-#### Version 1.2.191 - February 2025
+#### Version 1.3.15 - March 2025
 
 Tool to achieve the easiest way of communication with the map iframe.
 
@@ -329,6 +329,23 @@ This feature provides screenshot data, encoded as a PNG in Base64 format.
 {type: "screenshot", content: 'png in base64'
 ```
 
+##### print <a id="print-event"></a>
+
+Print events, when print process is active `print:true` and when print is ready `print:false, file: png file` 
+
+```
+
+{type: "print", content: {print:true/false, file:file})
+```
+
+##### dpi
+
+Map DPI changed
+
+```
+
+{type: "dpi", content: 96)
+```
 ## Methods
 
 ##### ZoomIn()
@@ -1125,6 +1142,55 @@ Will do an screenshot of the current map encoded as a PNG in Base64 format. Resu
 ```
 screenshot({});
 ```
+
+##### setDpi
+
+Change the map DPI resolution to improve quality in prints.
+
+Properties:
+- `dpi` - in pixels, default value is 96.
+
+```
+`¡setDpi(96)
+```
+
+##### Print
+
+The print process consists of two steps:
+
+1. Choose the area to be printed based on the paper size and layout.
+2. Capture a screenshot of the selected area and emit a print event with the PNG file.
+
+We recommend increasing the DPI before starting the print process using setDpi(300). Once the file is generated, restore the DPI to its default value using setDpi(96).
+
+###### Step 1 - startPrint
+
+This step will block map zoom and pan, and a draggable rectangle with the required size and proportions will be rendered.
+
+Properties:
+- `paperSize` - paper size `A3` | `A4` 
+- `paperLayout` - layout `landscape` | `portrait` 
+
+```
+startPrint({paperSize:'A4', paperLayout:'landscape'});
+```
+
+###### Step 2 - Print
+
+This step will remove the rectangle and generate a PNG file with the contents of the rectangle. Once ready, it will emit a print event with the file. Zoom and pan will be re-enabled.
+
+```
+print()
+```
+
+##### cancelPrint
+
+Cancel the print process. This will remove the rectangle and release zoom and pan.
+
+```
+cancelPrint()
+```
+
 ### Multiple iframes
 
 Is possible to use multiple iframe on a single page, follow this steps.

package/map-handler.d.ts

@@ -0,0 +1,134 @@
+import { EventEmitter } from 'events';
+
+declare module '@vidro/map-handler' {
+    import {
+        CommunicatorOptions,
+        Geometry,
+        HighlightOptions,
+        MapEventData,
+        AddGeomOptions,
+        LayerProperties,
+        PrintOptions,
+        IconOptions,
+        CustomColorsProperties,
+        ScreenshotOptions,
+        DpiOptions,
+    } from './src/types';
+
+    export class Communicator extends EventEmitter {
+        constructor(data: CommunicatorOptions);
+
+        // Event management
+        removeListener(event: string, listener: (...args: any[]) => void): this;
+        on(event: string, listener: (data: MapEventData) => void): this;
+        off(event: string, listener: (data: MapEventData) => void): this;
+
+        // Map controls
+        ZoomIn(): void;
+        ZoomOut(): void;
+        zoomToExtent(): void;
+        clear(): void;
+
+        // Geometry operations
+        AddGeom(geomtype: string, options?: AddGeomOptions): void;
+        CancelAddGeom(s?: any): void;
+        Highlight(options: HighlightOptions): void;
+        DrawGeometries(geoms: Geometry[]): void;
+        DrawGeometry(geom: any, styles: any, name?: string, id?: string): void;
+        RemoveGeometry(id: string, layer?: string | null): void;
+        RemoveGeometriesByProperty(layer: string, property: string, value: any): void;
+        UpdateGeometriesByProperty(layer: string, property: string, value: any, style: any): void;
+
+        // Layer management
+        loadMultipleLayers(layers: any[]): void;
+        toggleGroup(layers: any[]): void;
+        toggleLayer(layer: string, properties?: LayerProperties): void;
+        removeLayer(layer: string): void;
+        displayLayer(layer: string): void;
+        setActiveLayer(layer: string): void;
+        getActiveLayer(): void;
+        bringLayerToTop(layer: string): void;
+        bringLayerToBottom(layer: string): void;
+        loadWMSAvailableLayers(): void;
+        reloadDisplayedLayers(): void;
+
+        // Navigation
+        zoomToCoordinates(lat: number, lon: number, zoomLevel?: number): void;
+        zoomToGeometry(geom: any, limits?: any): void;
+        zoomToScale(scale: string): void;
+        CenterMap(lat: number, lon: number): void;
+
+        // Information
+        infoFromCoordinates(type: string, layer?: string, hitTolerance?: number, format?: string): void;
+        getElementsFromLayer(layer?: string, limit?: number, format?: string): void;
+
+        // Geolocation
+        Geolocalize(toggle: any, options?: any): void;
+
+        // Background
+        toggleGiswaterTiled(toggle: any, tiled: any): void;
+        toggleTiled(toggle: any, tiled: any): void;
+        getTiled(): void;
+        toggleSecondaryBackground(toggle: any): void;
+        getSecondaryBackground(): void;
+        changeBackground(newBackground: any): void;
+        getBackground(): void;
+
+        // GeoJSON
+        addGeoJSON(geoJSON: any, options?: any, name?: string): void;
+        clearGeoJSON(name: string): void;
+        removeGeoJSONLayer(name: string): void;
+
+        // Filters
+        setGiswaterFilters(filters: any): void;
+        setFilters(filters: any): void;
+        getGiswaterLayerAvailableFilters(layer_name: string): void;
+
+        // TOC
+        getToc(): void;
+
+        // Debug & Configuration
+        setDebug(what: number): void;
+        setCustomColors(properties: CustomColorsProperties): void;
+
+        // Measure tools
+        initMeasure(measure: any, textStart: string, textContinue: string): void;
+        cancelMeasure(): void;
+        setBboxSize(bbox: number): void;
+
+        // Icons
+        addIcon(options: IconOptions): void;
+
+        // Screenshot & Print
+        screenshot(options?: ScreenshotOptions): void;
+        setDpi(options?: DpiOptions): void;
+        print(options?: PrintOptions): void;
+        startPrint(options?: PrintOptions): void;
+        cancelPrint(options?: PrintOptions): void;
+    }
+
+    // Export constants if they exist
+    export const MAP_EVENTS: {
+        ZOOM_CHANGE: string;
+        LOADED: string;
+        CAPABILITIES: string;
+        ERROR: string;
+        GEOLOCATION: string;
+        END_MEASURE: string;
+        START_MEASURE: string;
+        UNLOADED: string;
+        COORDINATES: string;
+        CENTER_CHANGE: string;
+        ACTIVE_LAYER: string;
+        WMS_LAYERS: string;
+        STATUS: string;
+        INFO: string;
+        GEOM_ADDED: string;
+        LAYERS: string;
+        VERSION: string;
+        HOVER: string;
+        SCREENSHOT: string;
+        PRINT: string;
+        DPI: string;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vidro/map-handler",
-  "version": "1.3.14",
+  "version": "2.0.0",
   "description": "Tool to achieve the easiest way of communication with the map",
   "homepage": "https://github.com/Vidro-Software-SL/maphandler",
   "repository": {
@@ -8,11 +8,17 @@
     "url": "https://github.com/Vidro-Software-SL/maphandler.git"
   },
   "main": "dist/map-handler.js",
+  "types": "map-handler.d.ts",
+  "files": [
+    "dist",
+    "map-handler.d.ts",
+    "src/types.d.ts"
+  ],
   "scripts": {
     "build": "webpack"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": ["map", "gis", "communicator", "typescript"],
+  "author": "Vidro Software SL",
   "license": "ISC",
   "devDependencies": {
     "@babel/core": "^7.12.16",
@@ -25,4 +31,4 @@
   "dependencies": {
     "events": "^3.2.0"
   }
-}
+}

package/src/types.d.ts

@@ -0,0 +1,63 @@
+export interface CommunicatorOptions {
+    sessionToken: string;
+    id?: string;
+}
+
+export interface Geometry {
+    geom: string;
+    style?: string;
+    featureId?: string;
+    id?: string;
+}
+
+export interface HighlightOptions {
+    geom: string;
+    zoom?: number | null;
+    center?: boolean;
+    animate?: boolean;
+    data?: string;
+    style?: string;
+}
+
+export interface MapEventData {
+    type: string;
+    [key: string]: any;
+}
+
+export interface AddGeomOptions {
+    texts?: any;
+    style?: any;
+    drawOnEnd?: boolean;
+    showConfirm?: boolean;
+}
+
+export interface LayerProperties {
+    gutter?: number | null;
+    transparent?: boolean | null;
+    singletile?: boolean | null;
+    zIndex?: number | null;
+}
+
+export interface PrintOptions {
+    [key: string]: any;
+}
+
+export interface IconOptions {
+    icon: ArrayBuffer;
+    coordinates: [number, number];
+}
+
+export interface CustomColorsProperties {
+    geom_stroke_width?: number;
+    geom_radius?: number;
+    geom_shape?: 'circle' | 'square';
+    [key: string]: any;
+}
+
+export interface ScreenshotOptions {
+    [key: string]: any;
+}
+
+export interface DpiOptions {
+    [key: string]: any;
+}

package/.babelrc

@@ -1,6 +0,0 @@
-{
-  "presets": ["@babel/preset-env"],
-  "plugins": [
-    "@babel/plugin-proposal-class-properties"
-  ]
-}