@syncfusion/ej2-maps 30.2.4 → 31.2.2

package/dist/ts/maps/model/constants.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Maps constants doc
+ */
+/**
+ * Specifies the maps load event name.
+ *
+ * @private
+ */
+export declare const load: string;
+/**
+ * Specifies the maps loaded event name.
+ *
+ * @private
+ */
+export declare const loaded: string;
+/**
+ * Specifies the maps click event name.
+ *
+ * @private
+ */
+export declare const click: string;
+/**
+ * Specifies the maps onclick event name.
+ *
+ * @private
+ */
+export declare const onclick: string;
+/**
+ * Specifies the maps right click event name.
+ *
+ * @private
+ */
+export declare const rightClick: string;
+/**
+ * Specifies the maps double click event name.
+ *
+ * @private
+ */
+export declare const doubleClick: string;
+/**
+ * Specifies the maps resize event name.
+ *
+ * @private
+ */
+export declare const resize: string;
+/**
+ * Specifies the maps tooltip event name.
+ *
+ */
+export declare const tooltipRender: string;
+/**
+ * Specifies the map shape selected event.
+ *
+ */
+export declare const shapeSelected: string;
+/**
+ * Specifies the maps shape highlight event.
+ *
+ */
+export declare const shapeHighlight: string;
+/**
+ * Specifies the maps mouse move event name.
+ *
+ * @private
+ */
+export declare const mousemove: string;
+/**
+ * Specifies the maps mouse up event name.
+ *
+ * @private
+ */
+export declare const mouseup: string;
+/**
+ * Specifies the maps mouse down event name.
+ *
+ * @private
+ */
+export declare const mousedown: string;
+/**
+ * Specifies the maps layer rendering event name.
+ *
+ * @private
+ */
+export declare const layerRendering: string;
+/**
+ * Specifies the maps shape rendering event name.
+ *
+ * @private
+ */
+export declare const shapeRendering: string;
+/**
+ * Specifies the maps marker rendering event name.
+ *
+ * @private
+ */
+export declare const markerRendering: string;
+/**
+ * Specifies the maps cluster rendering event name.
+ *
+ * @private
+ */
+export declare const markerClusterRendering: string;
+/**
+ * Specifies the maps marker click event name.
+ *
+ * @private
+ */
+export declare const markerClick: string;
+/**
+ * Specifies the maps marker drag start event name.
+ *
+ * @private
+ */
+export declare const markerDragStart: string;
+/**
+ * Specifies the maps marker drag end event name.
+ *
+ * @private
+ */
+export declare const markerDragEnd: string;
+/**
+ * Specifies the maps cluster click event name.
+ *
+ * @private
+ */
+export declare const markerClusterClick: string;
+/**
+ * Specifies the maps marker mouse move event name.
+ *
+ * @private
+ */
+export declare const markerMouseMove: string;
+/**
+ * Specifies the maps mouse move event name.
+ *
+ * @private
+ */
+export declare const mouseMove: string;
+/**
+ * Specifies the maps cluster mouse move event name.
+ *
+ * @private
+ */
+export declare const markerClusterMouseMove: string;
+/**
+ * Specifies the maps data label rendering event name.
+ *
+ * @private
+ */
+export declare const dataLabelRendering: string;
+/**
+ * Specifies the maps bubbleRendering event name.
+ *
+ * @private
+ */
+export declare const bubbleRendering: string;
+/**
+ * Specifies the maps bubble click event name.
+ *
+ * @private
+ */
+export declare const bubbleClick: string;
+/**
+ * Specifies the maps bubble mouse move event name.
+ *
+ * @private
+ */
+export declare const bubbleMouseMove: string;
+/**
+ * Specifies the maps animation complete event name.
+ *
+ * @private
+ */
+export declare const animationComplete: string;
+/**
+ * Specifies the maps legend rendering event name.
+ *
+ * @private
+ */
+export declare const legendRendering: string;
+/**
+ * Specifies the maps annotation rendering event name.
+ *
+ * @private
+ */
+export declare const annotationRendering: string;
+/**
+ * Specifies the maps item selection event name.
+ *
+ * @private
+ */
+export declare const itemSelection: string;
+/**
+ * Specifies the maps pan complete event name.
+ *
+ * @private
+ */
+export declare const panComplete: string;
+/**
+ * Specifies the maps zoom complete event name.
+ *
+ * @private
+ */
+export declare const zoomComplete: string;
+/**
+ * Specifies the maps item highlight event name.
+ *
+ */
+export declare const itemHighlight: string;
+/**
+ * Specifies the maps before print event name.
+ */
+export declare const beforePrint: string;
+/**
+ * Specifies the maps zoom in event name.
+ */
+export declare const zoomIn: string;
+/**
+ * Specifies the maps zoom out event name.
+ */
+export declare const zoomOut: string;
+/**
+ * Specifies the maps pan event name.
+ */
+export declare const pan: string;

package/dist/ts/maps/model/constants.ts

@@ -0,0 +1,226 @@
+/**
+ * Maps constants doc
+ */
+
+/**
+ * Specifies the maps load event name.
+ *
+ * @private
+ */
+export const load: string = 'load';
+/**
+ * Specifies the maps loaded event name.
+ *
+ * @private
+ */
+export const loaded: string = 'loaded';
+/**
+ * Specifies the maps click event name.
+ *
+ * @private
+ */
+export const click: string = 'click';
+/**
+ * Specifies the maps onclick event name.
+ *
+ * @private
+ */
+export const onclick: string = 'onclick';
+/**
+ * Specifies the maps right click event name.
+ *
+ * @private
+ */
+export const rightClick: string = 'rightClick';
+/**
+ * Specifies the maps double click event name.
+ *
+ * @private
+ */
+export const doubleClick: string = 'doubleClick';
+/**
+ * Specifies the maps resize event name.
+ *
+ * @private
+ */
+export const resize: string = 'resize';
+/**
+ * Specifies the maps tooltip event name.
+ *
+ */
+export const tooltipRender: string = 'tooltipRender';
+/**
+ * Specifies the map shape selected event.
+ *
+ */
+export const shapeSelected: string = 'shapeSelected';
+/**
+ * Specifies the maps shape highlight event.
+ *
+ */
+export const shapeHighlight: string = 'shapeHighlight';
+/**
+ * Specifies the maps mouse move event name.
+ *
+ * @private
+ */
+export const mousemove: string = 'mousemove';
+/**
+ * Specifies the maps mouse up event name.
+ *
+ * @private
+ */
+export const mouseup: string = 'mouseup';
+/**
+ * Specifies the maps mouse down event name.
+ *
+ * @private
+ */
+export const mousedown: string = 'mousedown';
+/**
+ * Specifies the maps layer rendering event name.
+ *
+ * @private
+ */
+export const layerRendering: string = 'layerRendering';
+/**
+ * Specifies the maps shape rendering event name.
+ *
+ * @private
+ */
+export const shapeRendering: string = 'shapeRendering';
+/**
+ * Specifies the maps marker rendering event name.
+ *
+ * @private
+ */
+export const markerRendering: string = 'markerRendering';
+/**
+ * Specifies the maps cluster rendering event name.
+ *
+ * @private
+ */
+export const markerClusterRendering: string = 'markerClusterRendering';
+/**
+ * Specifies the maps marker click event name.
+ *
+ * @private
+ */
+export const markerClick: string = 'markerClick';
+/**
+ * Specifies the maps marker drag start event name.
+ *
+ * @private
+ */
+export const markerDragStart: string = 'markerDragStart';
+/**
+ * Specifies the maps marker drag end event name.
+ *
+ * @private
+ */
+export const markerDragEnd: string = 'markerDragEnd';
+/**
+ * Specifies the maps cluster click event name.
+ *
+ * @private
+ */
+export const markerClusterClick: string = 'markerClusterClick';
+/**
+ * Specifies the maps marker mouse move event name.
+ *
+ * @private
+ */
+export const markerMouseMove: string = 'markerMouseMove';
+/**
+ * Specifies the maps mouse move event name.
+ *
+ * @private
+ */
+export const mouseMove: string = 'mouseMove';
+/**
+ * Specifies the maps cluster mouse move event name.
+ *
+ * @private
+ */
+export const markerClusterMouseMove: string = 'markerClusterMouseMove';
+/**
+ * Specifies the maps data label rendering event name.
+ *
+ * @private
+ */
+export const dataLabelRendering: string = 'dataLabelRendering';
+/**
+ * Specifies the maps bubbleRendering event name.
+ *
+ * @private
+ */
+export const bubbleRendering: string = 'bubbleRendering';
+/**
+ * Specifies the maps bubble click event name.
+ *
+ * @private
+ */
+export const bubbleClick: string = 'bubbleClick';
+/**
+ * Specifies the maps bubble mouse move event name.
+ *
+ * @private
+ */
+export const bubbleMouseMove: string = 'bubbleMouseMove';
+/**
+ * Specifies the maps animation complete event name.
+ *
+ * @private
+ */
+export const animationComplete: string = 'animationComplete';
+/**
+ * Specifies the maps legend rendering event name.
+ *
+ * @private
+ */
+export const legendRendering: string = 'legendRendering';
+/**
+ * Specifies the maps annotation rendering event name.
+ *
+ * @private
+ */
+export const annotationRendering: string = 'annotationRendering';
+/**
+ * Specifies the maps item selection event name.
+ *
+ * @private
+ */
+export const itemSelection: string = 'itemSelection';
+/**
+ * Specifies the maps pan complete event name.
+ *
+ * @private
+ */
+export const panComplete: string = 'panComplete';
+/**
+ * Specifies the maps zoom complete event name.
+ *
+ * @private
+ */
+export const zoomComplete: string = 'zoomComplete';
+/**
+ * Specifies the maps item highlight event name.
+ *
+ */
+export const itemHighlight: string = 'itemHighlight';
+/**
+ * Specifies the maps before print event name.
+ */
+export const beforePrint: string = 'beforePrint';
+/**
+ * Specifies the maps zoom in event name.
+ */
+export const zoomIn: string = 'zoomIn';
+/**
+ * Specifies the maps zoom out event name.
+ */
+export const zoomOut: string = 'zoomOut';
+/**
+ * Specifies the maps pan event name.
+ */
+export const pan: string = 'pan';

package/dist/ts/maps/model/export-image.d.ts

@@ -0,0 +1,39 @@
+import { Maps } from '../../index';
+import { ExportType } from '../utils/enum';
+/**
+ * This module enables the export to Image functionality in maps.
+ *
+ * @hidden
+ */
+export declare class ImageExport {
+    /**
+     * Constructor for Maps
+     *
+     * @param {Maps} control - Specifies the instance of the map
+     */
+    constructor(control: Maps);
+    /**
+     * To export the file as image/svg format
+     *
+     * @param {Maps} maps - Specifies the Maps instance.
+     * @param {ExportType} type - Specifies the type of the image file for exporting.
+     * @param {string} fileName - Specifies the file name of the image file for exporting.
+     * @param {boolean} allowDownload - Specifies whether to download image as a file or not.
+     * @returns {Promise<string>} - Specifies the base64 string of the exported image which is returned when the allowDownload is set to false.
+     * @private
+     */
+    export(maps: Maps, type: ExportType, fileName: string, allowDownload?: boolean): Promise<string>;
+    /**
+     * Get module name.
+     *
+     * @returns {string} - Returns the module name
+     */
+    protected getModuleName(): string;
+    /**
+     * To destroy the ImageExport.
+     *
+     * @returns {void}
+     * @private
+     */
+    destroy(): void;
+}

package/dist/ts/maps/model/export-image.ts

@@ -0,0 +1,194 @@
+import { createElement, Browser, isNullOrUndefined } from '@syncfusion/ej2-base';
+import { Maps } from '../../index';
+import { triggerDownload, getElementByID } from '../utils/helper';
+import { ExportType } from '../utils/enum';
+
+/**
+ * This module enables the export to Image functionality in maps.
+ *
+ * @hidden
+ */
+export class ImageExport {
+
+    /**
+     * Constructor for Maps
+     *
+     * @param {Maps} control - Specifies the instance of the map
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
+    constructor(control: Maps) {
+    }
+    /**
+     * To export the file as image/svg format
+     *
+     * @param {Maps} maps - Specifies the Maps instance.
+     * @param {ExportType} type - Specifies the type of the image file for exporting.
+     * @param {string} fileName - Specifies the file name of the image file for exporting.
+     * @param {boolean} allowDownload - Specifies whether to download image as a file or not.
+     * @returns {Promise<string>} - Specifies the base64 string of the exported image which is returned when the allowDownload is set to false.
+     * @private
+     */
+    public export(maps: Maps, type: ExportType, fileName: string, allowDownload?: boolean): Promise<string> {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unused-vars
+        const promise: Promise<string> = new Promise((resolve: any, reject: any) => {
+            const imageCanvasElement: HTMLCanvasElement = <HTMLCanvasElement>createElement('canvas', {
+                id: 'ej2-canvas',
+                attrs: {
+                    'width': maps.availableSize.width.toString(),
+                    'height': maps.availableSize.height.toString()
+                }
+            });
+            const isDownload: boolean = !(Browser.userAgent.toString().indexOf('HeadlessChrome') > -1);
+            const svgParent: HTMLElement = document.getElementById(maps.element.id + '_Tile_SVG_Parent');
+            let svgDataElement: string;
+            let tileSvg: Element;
+            const svgObject: Element = getElementByID(maps.element.id + '_svg').cloneNode(true) as Element;
+            const backgroundElement: HTMLElement = svgObject.childNodes[0] as HTMLElement;
+            const backgroundColor: string = backgroundElement.getAttribute('fill');
+            if ((maps.theme === 'Tailwind' || maps.theme === 'Tailwind3' || maps.theme === 'Bootstrap5' || maps.theme === 'Fluent' || maps.theme === 'Material3' || maps.theme === 'Fluent2')
+                && (backgroundColor === 'rgba(255,255,255, 0.0)' || backgroundColor === 'transparent')) {
+                (svgObject.childNodes[0] as HTMLElement).setAttribute('fill', 'rgba(255,255,255, 1)');
+            } else if ((maps.theme === 'TailwindDark' || maps.theme === 'Tailwind3Dark' || maps.theme === 'Bootstrap5Dark' || maps.theme === 'FluentDark' || maps.theme === 'Material3Dark' ||
+                maps.theme === 'Fluent2Dark' || maps.theme === 'Fluent2HighContrast')
+                && (backgroundColor === 'rgba(255,255,255, 0.0)' || backgroundColor === 'transparent')) {
+                (svgObject.childNodes[0] as HTMLElement).setAttribute('fill', 'rgba(0, 0, 0, 1)');
+            }
+            if (!maps.isTileMap) {
+                svgDataElement = '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">' +
+                svgObject.outerHTML + '</svg>';
+            } else {
+                tileSvg = getElementByID(maps.element.id + '_Tile_SVG').cloneNode(true) as Element;
+                svgDataElement = '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">' +
+                svgObject.outerHTML + tileSvg.outerHTML + '</svg>';
+            }
+            const url: string = window.URL.createObjectURL(
+                new Blob(
+                    type === 'SVG' ? [svgDataElement] :
+                        [(new XMLSerializer()).serializeToString(svgObject)],
+                    { type: 'image/svg+xml' }
+                )
+            );
+            if (type === 'SVG') {
+                if (allowDownload) {
+                    triggerDownload(
+                        fileName, type,
+                        url, isDownload
+                    );
+                } else {
+                    resolve(null);
+                }
+            } else {
+                const image: HTMLImageElement = new Image();
+                const ctxt: CanvasRenderingContext2D = imageCanvasElement.getContext('2d');
+                if (!maps.isTileMap) {
+                    image.onload = (() => {
+                        ctxt.drawImage(image, 0, 0);
+                        window.URL.revokeObjectURL(url);
+                        if (allowDownload) {
+                            triggerDownload(
+                                fileName, type, imageCanvasElement.toDataURL('image/png').replace('image/png', 'image/octet-stream'),
+                                isDownload
+                            );
+                        } else {
+                            if (type === 'PNG') {
+                                resolve(imageCanvasElement.toDataURL('image/png'));
+                            } else if (type === 'JPEG') {
+                                resolve(imageCanvasElement.toDataURL('image/jpeg'));
+                            }
+                        }
+                    });
+                    image.src = url;
+                } else {
+                    maps.isExportInitialTileMap = true;
+                    const svgParentElement: HTMLElement = document.getElementById(maps.element.id + '_MapAreaBorder');
+                    const top: number = parseFloat(svgParentElement.getAttribute('y'));
+                    const left: number = parseFloat(svgParentElement.getAttribute('x'));
+                    const imgxHttp: XMLHttpRequest = new XMLHttpRequest();
+                    const imgTileLength: number = maps.mapLayerPanel.tiles.length;
+                    for (let i: number = 0; i <= imgTileLength + 1; i++) {
+                        const tile: HTMLElement = document.getElementById(maps.element.id + '_tile_' + (i - 1));
+                        const exportTileImg: HTMLImageElement = new Image();
+                        exportTileImg.crossOrigin = 'Anonymous';
+                        const background: string = maps.background ? maps.background : ((maps.theme === 'Tailwind' || maps.theme === 'Tailwind3' || maps.theme === 'Bootstrap5' || maps.theme === 'Fluent' || maps.theme === 'Material3') && (backgroundColor === 'rgba(255,255,255, 0.0)' || backgroundColor === 'transparent')) ? '#ffffff' :
+                            (maps.theme === 'TailwindDark' || maps.theme === 'Tailwind3Dark' || maps.theme === 'Bootstrap5Dark' || maps.theme === 'FluentDark' || maps.theme === 'Material3Dark') && (backgroundColor === 'rgba(255,255,255, 0.0)' || backgroundColor === 'transparent') ? '#000000' : '#ffffff';
+                        ctxt.fillStyle = background;
+                        ctxt.fillRect(0, 0, maps.availableSize.width, maps.availableSize.height);
+                        ctxt.font = maps.titleSettings.textStyle.size + ' Arial';
+                        const titleElement: HTMLElement = document.getElementById(maps.element.id + '_Map_title');
+                        if (!isNullOrUndefined(titleElement)) {
+                            ctxt.fillStyle = titleElement.getAttribute('fill');
+                            ctxt.fillText(
+                                maps.titleSettings.text, parseFloat(titleElement.getAttribute('x')),
+                                parseFloat(titleElement.getAttribute('y'))
+                            );
+                        }
+                        exportTileImg.onload = (() => {
+                            if (i === 0 || i === imgTileLength + 1) {
+                                if (i === 0) {
+                                    ctxt.setTransform(1, 0, 0, 1, 0, 0);
+                                    ctxt.rect(0, top, parseFloat(svgParent.style.width), parseFloat(svgParent.style.height));
+                                    ctxt.clip();
+                                } else {
+                                    ctxt.setTransform(1, 0, 0, 1, left, top);
+                                }
+                            } else {
+                                ctxt.setTransform(1, 0, 0, 1, parseFloat(tile.style.left) + left, parseFloat(tile.style.top) +
+                                    top);
+                            }
+                            ctxt.drawImage(exportTileImg, 0, 0);
+                            if (i === imgTileLength + 1) {
+                                localStorage.setItem('local-canvasImage', imageCanvasElement.toDataURL('image/png'));
+                                const localBase64: string = localStorage.getItem('local-canvasImage');
+                                if (allowDownload) {
+                                    triggerDownload(fileName, type, localBase64, isDownload);
+                                    localStorage.removeItem('local-canvasImage');
+                                    maps.isExportInitialTileMap = false;
+                                } else {
+                                    maps.isExportInitialTileMap = false;
+                                    if (type === 'PNG') {
+                                        resolve(localBase64);
+                                    } else if (type === 'JPEG') {
+                                        resolve(imageCanvasElement.toDataURL('image/jpeg'));
+                                    }
+                                }
+                            }
+                        });
+                        if (i === 0 || i === imgTileLength + 1) {
+                            if (i === 0) {
+                                exportTileImg.src = url;
+                            } else {
+                                setTimeout(() => {
+                                    exportTileImg.src = window.URL.createObjectURL(new Blob(
+                                        [(new XMLSerializer()).serializeToString(tileSvg)],
+                                        { type: 'image/svg+xml' }));
+                                }, 300);
+                            }
+                        } else {
+                            imgxHttp.open('GET', tile.children[0].getAttribute('src'), true);
+                            imgxHttp.send();
+                            exportTileImg.src = tile.children[0].getAttribute('src');
+                        }
+                    }
+                }
+            }
+        });
+        return promise;
+    }
+    /**
+     * Get module name.
+     *
+     * @returns {string} - Returns the module name
+     */
+    protected getModuleName(): string {
+        return 'ImageExport';
+    }
+
+    /**
+     * To destroy the ImageExport.
+     *
+     * @returns {void}
+     * @private
+     */
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    public destroy(): void { }
+}