@opengeoweb/webmap 9.28.1 → 9.29.1

package/src/lib/components/WMJSMap.d.ts

@@ -1,220 +1,222 @@
-import WMImageStore from './WMImageStore';
-import WMBBOX, { Bbox } from './WMBBOX';
-import { WMProjectionWH } from './WMProjection';
-import WMListener from './WMListener';
-import { CanvasBBOX, CanvasGeoLayer } from './WMCanvasBuffer';
-import WMJSDimension from './WMJSDimension';
-import MapPin from './WMMapPin';
-import WMLayer from './WMLayer';
-import { AnimationStep, IWMProj4, IWMJSMapMouseCoordinates } from './types';
-import { WMMemo } from './WMMemo';
-import type { TileServerDefinition, TileServerSettings } from '../utils';
-import type IWMJSMap from './IWMJSMap';
-export declare const bgMapImageStore: WMImageStore;
-/**
- * WMJSMap class
- */
-export default class WMJSMap implements IWMJSMap {
-    private _mouseX;
-    private _mouseDownX;
-    private _mouseY;
-    private _mouseDownY;
-    private _enableAutoPrefetching;
-    private _WebMapJSMapVersion;
-    private _mainElement;
-    private _srs;
-    private _width;
-    private _height;
-    private _layers;
-    private _baseLayers;
-    private _numBaseLayers;
-    private _divZoomBox;
-    private _divBoundingBox;
-    private _divDimInfo;
-    private _displayLegendInMap;
-    private _mapHeader;
-    private _currentCursor;
-    private _mapIsActivated;
-    private _isMapHeaderEnabled;
-    private _showScaleBarInMap;
-    private _showCursorCoordinates;
-    private _wmEventListener;
-    private canvasLayerBuffer;
-    private internalMapId;
-    private activeLayer;
-    private setTimeOffsetValue;
-    private setMessageValue;
-    private canvasErrors;
-    private resizeWidth;
-    private resizeHeight;
-    private wmAnimate;
-    private wmTileRenderer;
-    private mouseWheelBusy;
-    private wMFlyToBBox;
-    private _mouseWheelEventBBOXCurrent;
-    private _mouseWheelEventBBOXNew;
-    private mouseUpX;
-    private mouseUpY;
-    private mouseDragging;
-    private mouseDownPressed;
-    private mapMode;
-    private oldMapMode;
-    private resizingBBOXCursor;
-    private resizingBBOXEnabled;
-    private mouseGeoCoordXY;
-    private mouseUpdateCoordinates;
-    private mapPanning;
-    private mapPanStartGeoCoords;
-    private previousMouseButtonState;
-    private tileRenderSettings;
-    private needsRedraw;
-    private _pixelCoordinatesToXY;
-    private _makeComponentId;
-    private _adagucBeforeDraw;
-    private _adagucBeforeCanvasDisplay;
-    private _init;
-    private _rebuildMapDimensions;
-    private _checkInvalidMouseAction;
-    private _updateMouseCursorCoordinates;
-    private _setActive;
-    private _setActiveLayer;
-    private _calculateNumBaseLayers;
-    private _setSize;
-    private _abort;
-    private _makeInfoHTML;
-    private _draw;
-    private _drawReady;
-    private _drawAndLoad;
-    private _mouseDragStart;
-    private _mouseDrag;
-    private _mouseDragEnd;
-    private _mapPan;
-    private _mapPanPercentageEnd;
-    private _mapZoomStart;
-    private _showBoundingBox;
-    private _hideBoundingBox;
-    private _animFrameRedraw;
-    constructor(_element: HTMLElement);
-    _resizeBBOX: WMBBOX;
-    _defaultBBOX: WMBBOX;
-    _bbox: WMBBOX;
-    _updateBBOX: WMBBOX;
-    _drawnBBOX: WMBBOX;
-    _loadingDiv: HTMLElement;
-    _baseDiv: HTMLElement;
-    _mapZooming: 0 | 1;
-    _initialized: boolean;
-    _animationList: AnimationStep[] | string | undefined;
-    getLayerByServiceAndName(layerService: string, layerName: string): WMLayer;
-    redrawBuffer(): void;
-    addLayersToCanvasAndDisplayThem(): void;
-    _mouseDownEvent(e: MouseEvent): void;
-    _mouseMoveEvent(e: MouseEvent): void;
-    _mouseUpEvent(e: MouseEvent): void;
-    _display(): void;
-    _updateBoundingBox(_mapbbox: WMBBOX, triggerEvent?: boolean): void;
-    _mouseWheelEvent(event: WheelEvent): void;
-    _detachEvents(): void;
-    _attachEvents(): void;
-    _onContextMenu: () => boolean;
-    _mapPanStart(x: number, y: number): void;
-    _mapPanEnd(x: number, y: number): void;
-    _mapZoom(): void;
-    _mapZoomEnd(): void;
-    _getMouseCoordinatesForDocument(e: MouseEvent | TouchEvent): {
-        x: number;
-        y: number;
-    };
-    _setMouseCoordinates: (x: number, y: number) => void;
-    _getMouseCoordsForElement(e: MouseEvent | TouchEvent): {
-        x: number;
-        y: number;
-    };
-    prefetchLayerImagesForTimeMemo: WMMemo;
-    shouldPrefetch: boolean;
-    mapPin: MapPin;
-    mapdimensions: WMJSDimension[];
-    timestepInMinutes: number | undefined;
-    showLayerInfo: boolean;
-    stopAnimating: () => void;
-    isAnimating: boolean;
-    animationList: AnimationStep[] | string | undefined;
-    animationDelay: number;
-    currentAnimationStep: number;
-    initialAnimationStep: number;
-    setAnimationDelay: (delay: number) => void;
-    isDestroyed: boolean;
-    getMapImageStore: WMImageStore;
-    holdShiftToScroll: boolean;
-    getMapMouseCoordinates(): IWMJSMapMouseCoordinates;
-    setWMTileRendererTileSettings(tileRenderSettings: TileServerSettings): void;
-    addWMTileRendererTileSetting(tileRenderSetting: TileServerDefinition): void;
-    setMessage(message: string): void;
-    setTimeOffset(message: string): void;
-    getLayers(reverseOrder?: boolean): WMLayer[];
-    hasLayer(layer: WMLayer): boolean;
-    setLayer(layer: WMLayer): Promise<IWMJSMap>;
-    displayLayer(layer: WMLayer, enabled: boolean): void;
-    removeAllLayers(): void;
-    deleteLayer(layerToDelete: WMLayer): void;
-    /**
-     * Reorder layers according to an index array with indices on how the layers should be reordered.
-     */
-    reorderLayers(order: number[]): boolean;
-    configureMapDimensions(layer: WMLayer): void;
-    addLayer(layer: WMLayer): Promise<IWMJSMap>;
-    getActiveLayer(): WMLayer;
-    /**
-     * setProjection
-     * Set the projection of the current webmap object
-     *_srs also accepts a projectionProperty object
-     */
-    setProjection(_srs: string | {
-        srs: string;
-        bbox: Bbox;
-    }, _bbox?: Bbox): void;
-    getDrawBBOX(): WMBBOX;
-    getBBOX(): WMBBOX;
-    getProjection(): WMProjectionWH;
-    getSize(): {
-        width: number;
-        height: number;
-    };
-    getMapPin(): MapPin;
-    private _repositionLegendGraphic;
-    setSize(w: number, h: number): void;
-    hideMouseCursorProperties(): void;
-    displayScaleBarInMap(display: boolean): void;
-    draw(animationList?: AnimationStep[] | string | undefined): void;
-    getAlternativeImage(imageUrl: string, bbox: CanvasBBOX, filterBad?: boolean): CanvasGeoLayer[];
-    setBaseLayers(layer: WMLayer[]): void;
-    getBaseLayers(): WMLayer[];
-    getNumLayers(): number;
-    getBaseElement(): HTMLElement;
-    destroy(): void;
-    mouseDown(mouseCoordX: number, mouseCoordY: number, event?: MouseEvent): void;
-    mouseMove(mouseCoordX: number, mouseCoordY: number, event?: MouseEvent): void;
-    mouseUp(mouseCoordX: number, mouseCoordY: number, e: MouseEvent): void;
-    mapPanPercentage(percentageDiffX: number, percentageDiffY: number): void;
-    setCursor(cursor?: string): void;
-    getId(): string;
-    zoomTo(_newbbox: Bbox): void;
-    getProj4(): IWMProj4;
-    calculateBoundingBoxAndZoom(lat: number, lng: number): void;
-    addListener(name: string, f: (param?: any) => void, keep?: boolean): boolean;
-    removeListener(name: string, f: (param?: any) => void): void;
-    getListener(): WMListener;
-    suspendEvent(name: string): void;
-    resumeEvent(name: string): void;
-    getDimensionList(): WMJSDimension[];
-    getDimension(name: string): WMJSDimension;
-    setDimension(name: string, value: string, triggerEvent?: boolean, adjustLayerDims?: boolean): void;
-    zoomToLayer(_layer: WMLayer): void;
-    setDefaultBBOX(bbox: WMBBOX): void;
-    setBBOX(left: number | Bbox, bottom?: number, right?: number, top?: number): boolean;
-    zoomOut(ratio?: number): void;
-    zoomIn(ratio: number): void;
-    displayLegendInMap(_displayLegendInMap: boolean): void;
-    getImageStore(): WMImageStore;
-    clearImageCache(): void;
-}
+import { TFunction } from 'i18next';
+import WMImageStore from './WMImageStore';
+import WMBBOX, { Bbox } from './WMBBOX';
+import { WMProjectionWH } from './WMProjection';
+import WMListener from './WMListener';
+import { CanvasBBOX, CanvasGeoLayer } from './WMCanvasBuffer';
+import WMJSDimension from './WMJSDimension';
+import MapPin from './WMMapPin';
+import WMLayer from './WMLayer';
+import { AnimationStep, IWMProj4, IWMJSMapMouseCoordinates } from './types';
+import { WMMemo } from './WMMemo';
+import { type TileServerDefinition, type TileServerSettings } from '../utils';
+import type IWMJSMap from './IWMJSMap';
+export declare const bgMapImageStore: WMImageStore;
+/**
+ * WMJSMap class
+ */
+export default class WMJSMap implements IWMJSMap {
+    private _mouseX;
+    private _mouseDownX;
+    private _mouseY;
+    private _mouseDownY;
+    private _enableAutoPrefetching;
+    private _WebMapJSMapVersion;
+    private _mainElement;
+    private _srs;
+    private _width;
+    private _height;
+    private _layers;
+    private _baseLayers;
+    private _numBaseLayers;
+    private _divZoomBox;
+    private _divBoundingBox;
+    private _divDimInfo;
+    private _displayLegendInMap;
+    private _mapHeader;
+    private _currentCursor;
+    private _mapIsActivated;
+    private _isMapHeaderEnabled;
+    private _showScaleBarInMap;
+    private _showCursorCoordinates;
+    private _wmEventListener;
+    private canvasLayerBuffer;
+    private internalMapId;
+    private activeLayer;
+    private setTimeOffsetValue;
+    private setMessageValue;
+    private canvasErrors;
+    private resizeWidth;
+    private resizeHeight;
+    private wmAnimate;
+    private wmTileRenderer;
+    private mouseWheelBusy;
+    private wMFlyToBBox;
+    private _mouseWheelEventBBOXCurrent;
+    private _mouseWheelEventBBOXNew;
+    private mouseUpX;
+    private mouseUpY;
+    private mouseDragging;
+    private mouseDownPressed;
+    private mapMode;
+    private oldMapMode;
+    private resizingBBOXCursor;
+    private resizingBBOXEnabled;
+    private mouseGeoCoordXY;
+    private mouseUpdateCoordinates;
+    private mapPanning;
+    private mapPanStartGeoCoords;
+    private previousMouseButtonState;
+    private tileRenderSettings;
+    private needsRedraw;
+    private _pixelCoordinatesToXY;
+    private _makeComponentId;
+    private _adagucBeforeDraw;
+    private _adagucBeforeCanvasDisplay;
+    private _init;
+    private _rebuildMapDimensions;
+    private _checkInvalidMouseAction;
+    private _updateMouseCursorCoordinates;
+    private _setActive;
+    private _setActiveLayer;
+    private _calculateNumBaseLayers;
+    private _setSize;
+    private _abort;
+    private _makeInfoHTML;
+    private _draw;
+    private _drawReady;
+    private _drawAndLoad;
+    private _mouseDragStart;
+    private _mouseDrag;
+    private _mouseDragEnd;
+    private _mapPan;
+    private _mapPanPercentageEnd;
+    private _mapZoomStart;
+    private _showBoundingBox;
+    private _hideBoundingBox;
+    private _animFrameRedraw;
+    constructor(_element: HTMLElement);
+    _resizeBBOX: WMBBOX;
+    _defaultBBOX: WMBBOX;
+    _bbox: WMBBOX;
+    _updateBBOX: WMBBOX;
+    _drawnBBOX: WMBBOX;
+    _loadingDiv: HTMLElement;
+    _baseDiv: HTMLElement;
+    _mapZooming: 0 | 1;
+    _initialized: boolean;
+    _animationList: AnimationStep[] | string | undefined;
+    getLayerByServiceAndName(layerService: string, layerName: string): WMLayer;
+    redrawBuffer(): void;
+    addLayersToCanvasAndDisplayThem(): void;
+    _mouseDownEvent(e: MouseEvent): void;
+    _mouseMoveEvent(e: MouseEvent): void;
+    _mouseUpEvent(e: MouseEvent): void;
+    _display(): void;
+    _updateBoundingBox(_mapbbox: WMBBOX, triggerEvent?: boolean): void;
+    _mouseWheelEvent(event: WheelEvent): void;
+    _detachEvents(): void;
+    _attachEvents(): void;
+    _onContextMenu: () => boolean;
+    _mapPanStart(x: number, y: number): void;
+    _mapPanEnd(x: number, y: number): void;
+    _mapZoom(): void;
+    _mapZoomEnd(): void;
+    _getMouseCoordinatesForDocument(e: MouseEvent | TouchEvent): {
+        x: number;
+        y: number;
+    };
+    _setMouseCoordinates: (x: number, y: number) => void;
+    _getMouseCoordsForElement(e: MouseEvent | TouchEvent): {
+        x: number;
+        y: number;
+    };
+    prefetchLayerImagesForTimeMemo: WMMemo;
+    shouldPrefetch: boolean;
+    mapPin: MapPin;
+    mapdimensions: WMJSDimension[];
+    timestepInMinutes: number | undefined;
+    showLayerInfo: boolean;
+    stopAnimating: () => void;
+    isAnimating: boolean;
+    animationList: AnimationStep[] | string | undefined;
+    animationDelay: number;
+    currentAnimationStep: number;
+    initialAnimationStep: number;
+    setAnimationDelay: (delay: number) => void;
+    isDestroyed: boolean;
+    getMapImageStore: WMImageStore;
+    holdShiftToScroll: boolean;
+    t: TFunction | undefined;
+    getMapMouseCoordinates(): IWMJSMapMouseCoordinates;
+    setWMTileRendererTileSettings(tileRenderSettings: TileServerSettings): void;
+    addWMTileRendererTileSetting(tileRenderSetting: TileServerDefinition): void;
+    setMessage(message: string): void;
+    setTimeOffset(message: string): void;
+    getLayers(reverseOrder?: boolean): WMLayer[];
+    hasLayer(layer: WMLayer): boolean;
+    setLayer(layer: WMLayer): Promise<IWMJSMap>;
+    displayLayer(layer: WMLayer, enabled: boolean): void;
+    removeAllLayers(): void;
+    deleteLayer(layerToDelete: WMLayer): void;
+    /**
+     * Reorder layers according to an index array with indices on how the layers should be reordered.
+     */
+    reorderLayers(order: number[]): boolean;
+    configureMapDimensions(layer: WMLayer): void;
+    addLayer(layer: WMLayer): Promise<IWMJSMap>;
+    getActiveLayer(): WMLayer;
+    /**
+     * setProjection
+     * Set the projection of the current webmap object
+     *_srs also accepts a projectionProperty object
+     */
+    setProjection(_srs: string | {
+        srs: string;
+        bbox: Bbox;
+    }, _bbox?: Bbox): void;
+    getDrawBBOX(): WMBBOX;
+    getBBOX(): WMBBOX;
+    getProjection(): WMProjectionWH;
+    getSize(): {
+        width: number;
+        height: number;
+    };
+    getMapPin(): MapPin;
+    private _repositionLegendGraphic;
+    setSize(w: number, h: number): void;
+    hideMouseCursorProperties(): void;
+    displayScaleBarInMap(display: boolean): void;
+    draw(animationList?: AnimationStep[] | string | undefined): void;
+    getAlternativeImage(imageUrl: string, bbox: CanvasBBOX, filterBad?: boolean): CanvasGeoLayer[];
+    setBaseLayers(layer: WMLayer[]): void;
+    getBaseLayers(): WMLayer[];
+    getNumLayers(): number;
+    getBaseElement(): HTMLElement;
+    destroy(): void;
+    mouseDown(mouseCoordX: number, mouseCoordY: number, event?: MouseEvent): void;
+    mouseMove(mouseCoordX: number, mouseCoordY: number, event?: MouseEvent): void;
+    mouseUp(mouseCoordX: number, mouseCoordY: number, e: MouseEvent): void;
+    mapPanPercentage(percentageDiffX: number, percentageDiffY: number): void;
+    setCursor(cursor?: string): void;
+    getId(): string;
+    zoomTo(_newbbox: Bbox): void;
+    getProj4(): IWMProj4;
+    calculateBoundingBoxAndZoom(lat: number, lng: number): void;
+    addListener(name: string, f: (param?: any) => void, keep?: boolean): boolean;
+    removeListener(name: string, f: (param?: any) => void): void;
+    getListener(): WMListener;
+    suspendEvent(name: string): void;
+    resumeEvent(name: string): void;
+    getDimensionList(): WMJSDimension[];
+    getDimension(name: string): WMJSDimension;
+    setDimension(name: string, value: string, triggerEvent?: boolean, adjustLayerDims?: boolean): void;
+    zoomToLayer(_layer: WMLayer): void;
+    setDefaultBBOX(bbox: WMBBOX): void;
+    setBBOX(left: number | Bbox, bottom?: number, right?: number, top?: number): boolean;
+    zoomOut(ratio?: number): void;
+    zoomIn(ratio: number): void;
+    displayLegendInMap(_displayLegendInMap: boolean): void;
+    getImageStore(): WMImageStore;
+    clearImageCache(): void;
+}

package/src/lib/components/WMJSMap.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/src/lib/components/WMJSMapHelpers.d.ts

@@ -1,58 +1,59 @@
-import type WMLayer from './WMLayer';
-import type { Dimension, LinkedInfo, WMPosition } from './types';
-import type IWMJSMap from './IWMJSMap';
-import { WMProjectionWH } from './WMProjection';
-import { Bbox } from './WMBBOX';
-export declare const getBBOXandProjString: (layer: WMLayer, projection: WMProjectionWH) => string;
-export declare const buildWMSGetMapRequest: (layer: WMLayer, projection: WMProjectionWH, dimensionOverride?: Dimension[]) => {
-    url: string;
-    headers: Headers[];
-} | undefined;
-export declare const isProjectionSupported: (srs: string, proj4Defintions?: string[][]) => boolean;
-export declare const getWMSRequests: (map: IWMJSMap, dimensionOverride?: Dimension[]) => {
-    url: string;
-    headers: Headers[];
-}[];
-export declare const getLayerIndex: (layer: WMLayer, layers: WMLayer[]) => number;
-export declare const buildMapLayerDims: (map: IWMJSMap) => void;
-/**
- *  Makes a valid getfeatureinfoURL for each layer
- * @param layer
- * @param x
- * @param y
- * @param format
- * @returns
- */
-export declare const getWMSGetFeatureInfoRequestURL: (layer: WMLayer, x: number, y: number, format?: string) => string;
-export declare const getGeoCoordFromPixelCoord: (coordinates: WMPosition, bbox: Bbox, width: number, height: number) => WMPosition;
-export declare const getPixelCoordFromLatLong: (map: IWMJSMap, coordinates: {
-    x: number;
-    y: number;
-}) => {
-    x: number;
-    y: number;
-};
-export declare const getGeoCoordFromLatLong: (map: IWMJSMap, coordinates: {
-    x: number;
-    y: number;
-}) => {
-    x: number;
-    y: number;
-};
-export declare const getLatLongFromPixelCoord: (map: IWMJSMap, coordinates: {
-    x: number;
-    y: number;
-}) => {
-    x: number;
-    y: number;
-};
-export declare const getPixelCoordFromGeoCoord: (map: IWMJSMap, coordinates: {
-    x: number;
-    y: number;
-}, _bbox?: Bbox, _width?: number, _height?: number) => {
-    x: number;
-    y: number;
-};
-export declare const getErrorsToDisplay: (canvasErrors: LinkedInfo[], getLayerByServiceAndName: (layerservice: string, layername: string) => WMLayer) => string[];
-export declare const detectLeftButton: (evt?: MouseEvent) => boolean;
-export declare const detectRightButton: (evt?: MouseEvent) => boolean;
+import { TFunction } from 'i18next';
+import type WMLayer from './WMLayer';
+import type { Dimension, LinkedInfo, WMPosition } from './types';
+import type IWMJSMap from './IWMJSMap';
+import { WMProjectionWH } from './WMProjection';
+import { Bbox } from './WMBBOX';
+export declare const getBBOXandProjString: (layer: WMLayer, projection: WMProjectionWH) => string;
+export declare const buildWMSGetMapRequest: (layer: WMLayer, projection: WMProjectionWH, dimensionOverride?: Dimension[]) => {
+    url: string;
+    headers: Headers[];
+} | undefined;
+export declare const isProjectionSupported: (srs: string, proj4Defintions?: string[][]) => boolean;
+export declare const getWMSRequests: (map: IWMJSMap, dimensionOverride?: Dimension[]) => {
+    url: string;
+    headers: Headers[];
+}[];
+export declare const getLayerIndex: (layer: WMLayer, layers: WMLayer[]) => number;
+export declare const buildMapLayerDims: (map: IWMJSMap) => void;
+/**
+ *  Makes a valid getfeatureinfoURL for each layer
+ * @param layer
+ * @param x
+ * @param y
+ * @param format
+ * @returns
+ */
+export declare const getWMSGetFeatureInfoRequestURL: (layer: WMLayer, x: number, y: number, format?: string) => string;
+export declare const getGeoCoordFromPixelCoord: (coordinates: WMPosition, bbox: Bbox, width: number, height: number) => WMPosition;
+export declare const getPixelCoordFromLatLong: (map: IWMJSMap, coordinates: {
+    x: number;
+    y: number;
+}) => {
+    x: number;
+    y: number;
+};
+export declare const getGeoCoordFromLatLong: (map: IWMJSMap, coordinates: {
+    x: number;
+    y: number;
+}) => {
+    x: number;
+    y: number;
+};
+export declare const getLatLongFromPixelCoord: (map: IWMJSMap, coordinates: {
+    x: number;
+    y: number;
+}) => {
+    x: number;
+    y: number;
+};
+export declare const getPixelCoordFromGeoCoord: (map: IWMJSMap, coordinates: {
+    x: number;
+    y: number;
+}, _bbox?: Bbox, _width?: number, _height?: number) => {
+    x: number;
+    y: number;
+};
+export declare const getErrorsToDisplay: (canvasErrors: LinkedInfo[], getLayerByServiceAndName: (layerservice: string, layername: string) => WMLayer, t: TFunction | undefined) => string[];
+export declare const detectLeftButton: (evt?: MouseEvent) => boolean;
+export declare const detectRightButton: (evt?: MouseEvent) => boolean;

package/src/lib/components/WMJSMapHelpers.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};