@opengeoweb/webmap 9.10.2 → 9.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opengeoweb/webmap",
-  "version": "9.10.2",
+  "version": "9.12.0",
   "description": "GeoWeb webmap library for the opengeoweb project",
   "license": "Apache-2.0",
   "repository": {

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

@@ -4,7 +4,6 @@ export default class WMJSAnimate {
     private _map;
     private _divAnimationInfo;
     private _callBack;
-    private _imageStore;
     private isNextTimeCloseToWallClockTime;
     private animationTimer;
     private animateBusy;

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

@@ -2,8 +2,8 @@
 import WMImage from './WMImage';
 import WMImageStore from './WMImageStore';
 import WMBBOX from './WMBBOX';
-import WMListener from './WMListener';
 import { LinkedInfo, LinkedInfoContent, WMPosition } from './types';
+import type WMJSMap from './WMJSMap';
 interface InternalCallback {
     beforecanvasstartdraw?: (context: CanvasRenderingContext2D) => void;
     beforecanvasdisplay?: (context: CanvasRenderingContext2D) => void;
@@ -70,12 +70,11 @@ export default class WMCanvasBuffer {
     _imageStore: WMImageStore;
     ready: boolean;
     layers: CanvasGeoLayer[];
-    _defaultImage: WMImage;
     _currentbbox: WMBBOX;
     _currentnewbbox: WMBBOX;
     _width: number;
     _height: number;
-    _webmapJSCallback: WMListener;
+    _webMapJS: WMJSMap;
     nrLoading: number;
     onLoadReadyFunction: (param: unknown) => void;
     _internalCallbacks: InternalCallback;
@@ -84,7 +83,8 @@ export default class WMCanvasBuffer {
     animationFrameRequest: number;
     timerHandle: NodeJS.Timeout;
     _errorList: LinkedInfo[];
-    constructor(webmapJSCallback: WMListener, _imageStore: WMImageStore, w: number, h: number, internalCallbacks: InternalCallback);
+    _isBufferLoading: boolean;
+    constructor(webMapJS: WMJSMap, w: number, h: number, internalCallbacks: InternalCallback);
     getCanvasContext(): CanvasRenderingContext2D;
     /**
      * Triggered by the WMImageStore when an image completes loading
@@ -113,8 +113,11 @@ export default class WMCanvasBuffer {
      * @returns Void
      */
     setSrc(layerIndex: number, imageSource: string, linkedInfo: LinkedInfoContent, opacity: number, bbox: WMBBOX): void;
+    checkIfLoading(): void;
+    isImageStoreLoading(): boolean;
     _getPixelCoordFromGeoCoord(coordinates: WMPosition, b: WMBBOX): WMPosition;
     setBBOX(newbbox: WMBBOX, loadedbbox: WMBBOX): void;
+    destroy(): void;
     getBuffer(): HTMLCanvasElement;
 }
 export {};

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

@@ -27,3 +27,5 @@ export declare const epsgDescriptionLookup: {
 export declare const mapImageStoreLength = 1000;
 export declare const bgImageStoreLength = 360;
 export declare const legendImageStoreLength = 500;
+export declare const EVENT_GETCAPABILITIES_START = "onstartgetcapabilities";
+export declare const EVENT_GETCAPABILITIES_READY = "onreadygetcapabilities";

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

@@ -42,4 +42,3 @@ export default class WMImageStore {
      */
     getImage(src: string, loadOptions?: WMImageOptions): WMImage;
 }
-export declare const getMapImageStore: WMImageStore;

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

@@ -1,3 +1,4 @@
+import WMImageStore from './WMImageStore';
 import WMBBOX from './WMBBOX';
 import WMListener from './WMListener';
 import { proj4 } from './WMJSExternalDependencies';
@@ -5,15 +6,17 @@ import WMJSDimension from './WMJSDimension';
 import MapPin from './WMMapPin';
 import WMLayer from './WMLayer';
 import { AnimationStep, Dimension, LinkedInfo } from './types';
+import { WMMemo } from './WMMemo';
 export declare const detectLeftButton: (evt: MouseEvent) => boolean;
 export declare const detectRightButton: (evt: MouseEvent) => boolean;
 export declare const getErrorsToDisplay: (canvasErrors: LinkedInfo[], getLayerByServiceAndName: (layerservice: string, layername: string) => WMLayer) => string[];
-export declare const clearImageCache: () => void;
 /**
 /**
   * WMJSMap class
   */
 export default class WMJSMap {
+    prefetchLayerImagesForTimeMemo: WMMemo;
+    shouldPrefetch: boolean;
     mapPin: MapPin;
     mapdimensions: WMJSDimension[];
     timestepInMinutes: number | undefined;
@@ -113,6 +116,7 @@ export default class WMJSMap {
     private needsRedraw;
     private buildLayerDimsBusy;
     isProjectionSupported: (srs: string) => boolean;
+    getMapImageStore: WMImageStore;
     constructor(_element: HTMLElement);
     setWMTileRendererTileSettings(_WMTileRendererTileSettings: unknown): void;
     /**
@@ -316,4 +320,6 @@ export default class WMJSMap {
     showBoundingBox(_bbox?: WMBBOX, _mapbbox?: WMBBOX): void;
     hideBoundingBox(): void;
     getDrawBBOX(): WMBBOX;
+    getImageStore(): WMImageStore;
+    clearImageCache(): void;
 }

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

@@ -1,4 +1,6 @@
 import { LayerProps, LayerTree, WMSLayerFromGetCapabilities } from './types';
+import WMListener from './WMListener';
+export declare const wmServiceListener: WMListener;
 export interface GetCapabilitiesJson {
     WMS_Capabilities?: any;
     WMT_MS_Capabilities?: any;

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

@@ -60,7 +60,7 @@ export declare const getUriAddParam: (baseUrl: string, params: Record<string, an
  */
 export declare const dateToISO8601: (date: Date) => string;
 /**
- * Helper function to figure out the styles from the WMS layer object from the WMS GetCapabilties document
+ * Helper function to figure out the styles from the WMS layer object from the WMS GetCapabilities document
  * @param layerObjectFromWMS The layer object from the WMS GetCapabilities JSON document
  * @returns Style[] Array of style objects.
  */

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

@@ -140,7 +140,7 @@ export default class WMLayer {
     parseLayer(_layerDoneCallback: (layer: WMLayer) => void, forceReload: boolean, origin: string): void;
     /**
      * A Promise to parse the layer, it will fetch the WMS GetCapabilities document, configure the layer and resolve to a WMLayer object
-     * @param forceReload Do not use the cache of the WMS GetCapabilties document, but instead fetch new data from the server
+     * @param forceReload Do not use the cache of the WMS GetCapabilities document, but instead fetch new data from the server
      * @returns WMLayer object
      */
     parseLayerPromise(forceReload?: boolean): Promise<WMLayer>;

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

@@ -1,21 +1,57 @@
-export interface CallBack {
-    name: string;
-    finished: number;
-    keepOnCall: boolean;
-    functionpointer: (param?: unknown, that?: unknown) => void;
-}
-export type SuspendedEvent = Record<string, boolean>;
 export default class WMListener {
-    private _callBacks;
+    private registeredEvents;
     private _suspendedEvents;
-    private _allEventsSuspended;
+    private _suspendAllEvents;
     constructor();
-    addToCallback(name: string, functionpointer: (param: unknown) => void, keepOnCall?: boolean): boolean;
-    removeEvents(name: string, f: (param?: unknown) => unknown): void;
+    /**
+     * Remove events by name and function.
+     * @param name Event name
+     * @param f  Function pointer to check
+     */
+    removeEventListener(name: string, f: (param?: unknown) => unknown): number;
+    /**
+     * Remove all events by name
+     * @param name Event name
+     */
+    removeEventListeners(name: string): number;
+    /**
+     * Add multiple functions which will be called after the event with the same name is triggered
+     * @param name: The name of the event to register
+     * @param function: The function to trigger
+     * @param keepOnCall: When false, this event name and function combination is removed once triggered.
+     *                    When true Otherwise keep the event and allow it to be triggered multiple times
+     * @return: true if the event is registerd, false if it already was registered
+     */
+    addEventListener(name: string, functionpointer: (param: unknown) => void, keepOnCall?: boolean): boolean;
+    /**
+     * Destroys this listener, deregistering all events
+     */
     destroy(): void;
+    /**
+     * Suspend a specific event by name, triggers will not be called
+     * @param name
+     */
     suspendEvent(name: string): void;
+    /**
+     * Resume a specific event by name, resuming normal operation
+     * @param name
+     */
     resumeEvent(name: string): void;
+    /**
+     * This listener will not listen to any triggers
+     */
     suspendEvents(): void;
+    /**
+     * Resume event listening
+     */
     resumeEvents(): void;
+    /**
+     * Trigger an event with custom parameters
+     * @param name The name of the event to trigger
+     * @param param The parameters to provide to the associated function
+     * @returns The results of the function.
+     */
     triggerEvent(name: string, param?: unknown): unknown[];
+    private removeFinishedEvents;
+    removeEvents(name: string, f?: (param?: unknown) => unknown): number;
 }

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

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

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

@@ -0,0 +1,5 @@
+export declare class WMMemo {
+    constructor();
+    obj: object;
+    checkIfChanged(obj: object): boolean;
+}

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

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

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

@@ -5,5 +5,5 @@ interface PrefetchRequest {
     headers: Headers[];
 }
 export declare function getLayersImageUrlsForTime(wmMap: WMJSMap, timeToPrefetch: string): PrefetchRequest[];
-export declare function prefetchImagesForNonAnimation(wmMap: WMJSMap, maxImagesToPrefetch?: number): void;
+export declare function prefetchImagesForNonAnimation(wmMap: WMJSMap, maxImagesToPrefetch?: number, batchSize?: number): void;
 export {};

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

@@ -1,19 +1,20 @@
-import WMJSMap, { clearImageCache } from './WMJSMap';
+import WMJSMap from './WMJSMap';
 import { isDefined, WMJScheckURL, URLDecode, URLEncode, toArray, debugLogger, DebugType, getUriWithParam } from './WMJSTools';
 import WMGetServiceFromStore from './WMGetServiceFromStore';
 import { parseISO8601DateToDate, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration } from './WMTime';
 import I18n from '../utils/I18n/lang.en';
 import WMImage from './WMImage';
 import { getLegendGraphicURLForLayer, legendImageStore } from './WMLegend';
-import { getMapImageStore, WMImageEventType } from './WMImageStore';
-import { WMJSService } from './WMJSService';
+import { WMImageEventType } from './WMImageStore';
+import { WMJSService, wmServiceListener } from './WMJSService';
 import { getAlternativeImage } from './WMCanvasBuffer';
+import WMListener from './WMListener';
 export { default as WMJSDimension, handleMomentISOString, } from './WMJSDimension';
 export { default as WMLayer, LayerType } from './WMLayer';
 export type { LayerOptions, LayerFoundation } from './WMLayer';
 export { default as WMBBOX } from './WMBBOX';
 export type { Bbox } from './WMBBOX';
-export { WMJSMap, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration, isDefined, WMGetServiceFromStore, WMJScheckURL, URLEncode, URLDecode, parseISO8601DateToDate, I18n, toArray, getLegendGraphicURLForLayer, legendImageStore, WMImage, debugLogger, DebugType, WMImageEventType, WMJSService, getMapImageStore, clearImageCache, getUriWithParam, getAlternativeImage, };
+export { WMJSMap, DateInterval, parseISO8601IntervalToDateInterval, ParseISOTimeRangeDuration, isDefined, WMGetServiceFromStore, WMJScheckURL, URLEncode, URLDecode, parseISO8601DateToDate, I18n, toArray, getLegendGraphicURLForLayer, legendImageStore, WMImage, debugLogger, DebugType, WMImageEventType, WMJSService, getUriWithParam, getAlternativeImage, wmServiceListener, WMListener, };
 export * from './types';
 export * from './WMTimeTypes';
 export * from './WMConstants';

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

@@ -97,7 +97,7 @@ export interface WMSBoundingBox {
     };
 }
 /**
- * This interface is for reading from the WMS GetCapabilties document, which can have different structures for V1.1.1 and V1.3.0
+ * This interface is for reading from the WMS GetCapabilities document, which can have different structures for V1.1.1 and V1.3.0
  */
 export interface WMSLayerFromGetCapabilities {
     attr: {

package/src/lib/utils/index.d.ts

@@ -4,3 +4,6 @@ export * as webmapUtils from './utils';
 export * from './utils';
 export * from './testUtils';
 export * from './getCapabilities';
+export type { SpeedFactorType } from './mapConstants';
+export * as mapConstants from './mapConstants';
+export { speedFactors } from './mapConstants';

package/src/lib/utils/mapConstants.d.ts

@@ -0,0 +1,7 @@
+export declare const defaultAnimationDelayAtStart = 250;
+export declare const defaultDelay = 1000;
+export declare const defaultTimeStep = 60;
+export declare const defaultSecondsPerPx = 80;
+export declare const defaultTimeSpan: number;
+export type SpeedFactorType = 0.1 | 0.2 | 0.5 | 1 | 2 | 4 | 8 | 16;
+export declare const speedFactors: SpeedFactorType[];

package/src/lib/utils/utils.d.ts

@@ -1,4 +1,5 @@
 import type { WMJSDimension, WMJSMap, WMLayer } from '../components';
+import { SpeedFactorType } from './mapConstants';
 export declare const generateLayerId: () => string;
 export declare const generateMapId: () => string;
 export declare const generateTimesliderId: () => string;
@@ -44,3 +45,12 @@ export declare const getWMJSDimensionForLayerAndDimension: (layerId: string, dim
  * @return: The WMJSDimension if found, otherwise null
  */
 export declare const getWMJSTimeDimensionForLayerId: (layerId: string) => WMJSDimension;
+/**
+ * Clears the image store for all maps
+ */
+export declare const clearImageCacheForAllMaps: () => void;
+export declare const roundWithTimeStep: (unixTime: number, timeStep: number, type?: string) => number;
+/**
+ * Returns speed delay for given speedFactor. For options, see defined above in "speedFactors"
+ */
+export declare const getSpeedDelay: (speedFactor: SpeedFactorType) => number;