mobility-toolbox-js 3.0.0-beta.19 → 3.0.0-beta.20

package/ol/layers/RealtimeLayer.js

@@ -1,13 +1,13 @@
+import debounce from 'lodash.debounce';
 import GeoJSON from 'ol/format/GeoJSON';
 import { Vector as VectorLayer } from 'ol/layer';
-import Source from 'ol/source/Source';
-import { Vector as VectorSource } from 'ol/source';
-import debounce from 'lodash.debounce';
 import Layer from 'ol/layer/Layer';
+import { Vector as VectorSource } from 'ol/source';
+import Source from 'ol/source/Source';
 import RealtimeLayerMixin from '../../common/mixins/RealtimeLayerMixin';
-import { fullTrajectoryStyle } from '../styles';
 import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
 import RealtimeLayerRenderer from '../renderers/RealtimeLayerRenderer';
+import { fullTrajectoryStyle } from '../styles';
 /** @private */
 const format = new GeoJSON();
 /**
@@ -30,7 +30,7 @@ const format = new GeoJSON();
  * @classproperty {boolean} allowRenderWhenAnimating - Allow rendering of the layer when the map is animating.
  * @public
  */
-// @ts-ignore
+// @ts-expect-error
 class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
     /**
      * Constructor.
@@ -52,48 +52,42 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
         // We store the layer used to highlight the full Trajectory
         /** @private */
         this.vectorLayer = new VectorLayer({
-            updateWhileAnimating: this.allowRenderWhenAnimating,
-            updateWhileInteracting: true,
             source: new VectorSource({ features: [] }),
             style: (feature, resolution) => {
                 return (options.fullTrajectoryStyle || fullTrajectoryStyle)(feature, resolution, this.styleOptions);
             },
+            updateWhileAnimating: this.allowRenderWhenAnimating,
+            updateWhileInteracting: true,
         });
         // Options the last render run did happen. If something changes
         // we have to render again
         /** @private */
         this.renderState = {
             center: [0, 0],
-            zoom: undefined,
             rotation: 0,
+            zoom: undefined,
         };
         /** @private */
         this.onZoomEndDebounced = debounce(this.onZoomEnd, 100);
         /** @private */
         this.onMoveEndDebounced = debounce(this.onMoveEnd, 100);
     }
-    /**
-     * @private
-     */
-    createRenderer() {
-        return new RealtimeLayerRenderer(this);
-    }
     /** @private */
     attachToMap(map) {
         super.attachToMap(map);
         if (this.map) {
             // If the layer is visible we start  the rendering clock
-            if (this.visible) {
+            if (this.getVisible()) {
                 this.start();
             }
-            // @ts-expect-error - bad ts check RealtimeLayer is a BaseLayer
+            // @ts-expect-error  - bad ts check RealtimeLayer is a BaseLayer
             const index = this.map.getLayers().getArray().indexOf(this);
             this.map.getLayers().insertAt(index, this.vectorLayer);
             this.olEventsKeys.push(...this.map.on(['moveend', 'change:target'], 
-            // @ts-expect-error - bad ol definitions
+            // @ts-expect-error  - bad ol definitions
             (evt) => {
                 const view = (evt.map || evt.target).getView();
-                if (view.getAnimating() || view.getInteracting()) {
+                if (!view || (view === null || view === void 0 ? void 0 : view.getAnimating()) || (view === null || view === void 0 ? void 0 : view.getInteracting())) {
                     return;
                 }
                 const zoom = view.getZoom();
@@ -105,7 +99,7 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
                 this.currentZoom = zoom;
                 this.onMoveEndDebounced(evt);
             }), this.on('change:visible', (evt) => {
-                if (evt.target.visible) {
+                if (evt.target.getVisible()) {
                     this.start();
                 }
                 else {
@@ -120,13 +114,18 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
         }
     }
     /**
-     * Destroy the container of the tracker.
+     * Create a copy of the RealtimeLayer.
+     * @param {Object} newOptions Options to override
+     * @return {RealtimeLayer} A RealtimeLayer
+     */
+    clone(newOptions) {
+        return new RealtimeLayer(Object.assign(Object.assign({}, this.options), newOptions));
+    }
+    /**
      * @private
      */
-    detachFromMap() {
-        var _a;
-        (_a = this.map) === null || _a === void 0 ? void 0 : _a.removeLayer(this.vectorLayer);
-        super.detachFromMap();
+    createRenderer() {
+        return new RealtimeLayerRenderer(this);
     }
     /**
      * Render the trajectories using current map's size, resolution and rotation.
@@ -134,63 +133,25 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
      * @overrides
      * @private
      */
-    // @ts-ignore
-    renderTrajectories(noInterpolate) {
-        if (!this.map) {
-            return;
-        }
-        const view = this.map.getView();
-        // it could happen that the view is set but without center yet,
-        // so the calcualteExtent will trigger an error.
-        if (!view.getCenter()) {
-            return;
-        }
-        super.renderTrajectories({
-            size: this.map.getSize(),
-            center: view.getCenter(),
-            extent: view.calculateExtent(),
-            resolution: view.getResolution(),
-            rotation: view.getRotation(),
-            zoom: view.getZoom(),
-            pixelRatio: this.pixelRatio,
-        }, noInterpolate);
-    }
     /**
-     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
+     * Destroy the container of the tracker.
      * @private
-     * @override
      */
-    renderTrajectoriesInternal(viewState, noInterpolate) {
-        if (!this.map) {
-            return false;
-        }
-        let isRendered = false;
-        const blockRendering = this.allowRenderWhenAnimating
-            ? false
-            : this.map.getView().getAnimating() ||
-                this.map.getView().getInteracting();
-        // Don't render the map when the map is animating or interacting.
-        isRendered = blockRendering
-            ? false
-            : super.renderTrajectoriesInternal(viewState, noInterpolate);
-        // We update the current render state.
-        if (isRendered) {
-            /** @private */
-            this.renderedViewState = Object.assign({}, viewState);
-            // @ts-expect-error - we are in the same class
-            const { container } = this.getRenderer();
-            if (container) {
-                container.style.transform = '';
-            }
-        }
-        return isRendered;
+    detachFromMap() {
+        var _a;
+        (_a = this.map) === null || _a === void 0 ? void 0 : _a.removeLayer(this.vectorLayer);
+        super.detachFromMap();
     }
     /**
      * Return the delay in ms before the next rendering.
      * @private
      */
     getRefreshTimeInMs() {
-        return super.getRefreshTimeInMs(this.map.getView().getZoom());
+        var _a;
+        return super.getRefreshTimeInMs(((_a = this.map.getView()) === null || _a === void 0 ? void 0 : _a.getZoom()) || 0);
+    }
+    highlight(feature) {
+        this.highlightVehicle(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
     }
     /**
      * On move end we update the websocket with the new bbox.
@@ -198,12 +159,36 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
      * @private
      * @override
      */
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onMoveEnd(evt) {
-        if (!this.isUpdateBboxOnMoveEnd || !this.visible) {
-            return;
+    /**
+     * Highlight the trajectory of journey.
+     * @private
+     */
+    highlightTrajectory(id) {
+        var _a, _b, _c, _d;
+        if (!id) {
+            (_b = (_a = this.vectorLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear(true);
+            return Promise.resolve([]);
         }
-        this.setBbox();
+        return this.api
+            .getFullTrajectory(id, this.mode, this.getGeneralizationLevelByZoom(Math.floor(((_d = (_c = this.map) === null || _c === void 0 ? void 0 : _c.getView()) === null || _d === void 0 ? void 0 : _d.getZoom()) || 0)))
+            .then((data) => {
+            var _a, _b, _c, _d, _e;
+            const fullTrajectory = data.content;
+            if (!((_a = fullTrajectory === null || fullTrajectory === void 0 ? void 0 : fullTrajectory.features) === null || _a === void 0 ? void 0 : _a.length)) {
+                return [];
+            }
+            const features = format.readFeatures(fullTrajectory);
+            (_c = (_b = this.vectorLayer) === null || _b === void 0 ? void 0 : _b.getSource()) === null || _c === void 0 ? void 0 : _c.clear(true);
+            if (features.length) {
+                (_e = (_d = this.vectorLayer) === null || _d === void 0 ? void 0 : _d.getSource()) === null || _e === void 0 ? void 0 : _e.addFeatures(features);
+            }
+            return features;
+        })
+            .catch(() => {
+            var _a, _b;
+            (_b = (_a = this.vectorLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear(true);
+            return [];
+        });
     }
     /**
      * Function called on moveend event only when the zoom has changed.
@@ -212,22 +197,37 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
      * @private
      * @override
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onMoveEnd(evt) {
+        if (!this.isUpdateBboxOnMoveEnd || !this.getVisible()) {
+            return;
+        }
+        this.setBbox();
+    }
     // eslint-disable-next-line no-unused-vars
     onZoomEnd() {
         super.onZoomEnd();
-        if (!this.isUpdateBboxOnMoveEnd || !this.visible) {
+        if (!this.isUpdateBboxOnMoveEnd || !this.getVisible()) {
             return;
         }
         if (this.selectedVehicleId) {
             this.highlightTrajectory(this.selectedVehicleId);
         }
     }
-    highlight(feature) {
-        this.highlightVehicle(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
-    }
-    select(feature) {
-        this.selectVehicle(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
-        this.highlightTrajectory(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
+    /**
+     * Remove the trajectory form the list if necessary.
+     *
+     * @private
+     */
+    purgeTrajectory(trajectory, extent, zoom) {
+        var _a;
+        const center = (_a = this.map.getView()) === null || _a === void 0 ? void 0 : _a.getCenter();
+        if (!extent && !center) {
+            // In that case the view is not zoomed yet so we can't calculate the extent of the map,
+            // it will trigger a js error on calculateExtent function.
+            return false;
+        }
+        return super.purgeTrajectory(trajectory, extent || this.map.getView().calculateExtent(), zoom || this.map.getView().getZoom() || 0);
     }
     // /**
     //  * Update the cursor style when hovering a vehicle.
@@ -259,19 +259,61 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
     //   super.onFeatureClick(features, layer, coordinate);
     //   this.highlightTrajectory(this.selectedVehicleId);
     // }
+    // @ts-expect-error
+    renderTrajectories(noInterpolate) {
+        if (!this.map) {
+            return;
+        }
+        const view = this.map.getView();
+        // it could happen that the view is set but without center yet,
+        // so the calcualteExtent will trigger an error.
+        if (!(view === null || view === void 0 ? void 0 : view.getCenter())) {
+            return;
+        }
+        super.renderTrajectories({
+            center: view.getCenter(),
+            extent: view.calculateExtent(),
+            pixelRatio: this.pixelRatio,
+            resolution: view.getResolution(),
+            rotation: view.getRotation(),
+            size: this.map.getSize(),
+            zoom: view.getZoom(),
+        }, noInterpolate);
+    }
     /**
-     * Remove the trajectory form the list if necessary.
-     *
+     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
      * @private
+     * @override
      */
-    purgeTrajectory(trajectory, extent, zoom) {
-        const center = this.map.getView().getCenter();
-        if (!extent && !center) {
-            // In that case the view is not zoomed yet so we can't calculate the extent of the map,
-            // it will trigger a js error on calculateExtent function.
+    renderTrajectoriesInternal(viewState, noInterpolate) {
+        var _a;
+        if (!((_a = this.map) === null || _a === void 0 ? void 0 : _a.getView())) {
             return false;
         }
-        return super.purgeTrajectory(trajectory, extent || this.map.getView().calculateExtent(), zoom || this.map.getView().getZoom() || 0);
+        let isRendered = false;
+        const blockRendering = this.allowRenderWhenAnimating
+            ? false
+            : this.map.getView().getAnimating() ||
+                this.map.getView().getInteracting();
+        // Don't render the map when the map is animating or interacting.
+        isRendered = blockRendering
+            ? false
+            : super.renderTrajectoriesInternal(viewState, noInterpolate);
+        // We update the current render state.
+        if (isRendered) {
+            /** @private */
+            this.renderedViewState = Object.assign({}, viewState);
+            // @ts-expect-error  - we are in the same class
+            const { container } = this.getRenderer();
+            if (container) {
+                container.style.transform = '';
+            }
+        }
+        return isRendered;
+    }
+    select(feature) {
+        this.selectVehicle(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
+        this.highlightTrajectory(feature === null || feature === void 0 ? void 0 : feature.get('train_id'));
     }
     /**
      * Send the current bbox to the websocket
@@ -279,47 +321,13 @@ class RealtimeLayer extends RealtimeLayerMixin(MobilityLayerMixin(Layer)) {
      * @private
      */
     setBbox(extent, zoom) {
-        super.setBbox(extent ||
-            this.map.getView().calculateExtent(), zoom || this.map.getView().getZoom() || 0);
-    }
-    /**
-     * Highlight the trajectory of journey.
-     * @private
-     */
-    highlightTrajectory(id) {
         var _a, _b, _c, _d;
-        if (!id) {
-            (_b = (_a = this.vectorLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear(true);
-            return Promise.resolve([]);
+        const extentt = extent ||
+            ((_b = (_a = this.map) === null || _a === void 0 ? void 0 : _a.getView()) === null || _b === void 0 ? void 0 : _b.calculateExtent());
+        if (!extentt) {
+            return;
         }
-        return this.api
-            .getFullTrajectory(id, this.mode, this.getGeneralizationLevelByZoom(Math.floor(((_d = (_c = this.map) === null || _c === void 0 ? void 0 : _c.getView()) === null || _d === void 0 ? void 0 : _d.getZoom()) || 0)))
-            .then((data) => {
-            var _a, _b, _c, _d, _e;
-            const fullTrajectory = data.content;
-            if (!((_a = fullTrajectory === null || fullTrajectory === void 0 ? void 0 : fullTrajectory.features) === null || _a === void 0 ? void 0 : _a.length)) {
-                return [];
-            }
-            const features = format.readFeatures(fullTrajectory);
-            (_c = (_b = this.vectorLayer) === null || _b === void 0 ? void 0 : _b.getSource()) === null || _c === void 0 ? void 0 : _c.clear(true);
-            if (features.length) {
-                (_e = (_d = this.vectorLayer) === null || _d === void 0 ? void 0 : _d.getSource()) === null || _e === void 0 ? void 0 : _e.addFeatures(features);
-            }
-            return features;
-        })
-            .catch(() => {
-            var _a, _b;
-            (_b = (_a = this.vectorLayer) === null || _a === void 0 ? void 0 : _a.getSource()) === null || _b === void 0 ? void 0 : _b.clear(true);
-            return [];
-        });
-    }
-    /**
-     * Create a copy of the RealtimeLayer.
-     * @param {Object} newOptions Options to override
-     * @return {RealtimeLayer} A RealtimeLayer
-     */
-    clone(newOptions) {
-        return new RealtimeLayer(Object.assign(Object.assign({}, this.options), newOptions));
+        super.setBbox(extentt, zoom || ((_d = (_c = this.map) === null || _c === void 0 ? void 0 : _c.getView()) === null || _d === void 0 ? void 0 : _d.getZoom()) || 0);
     }
 }
 export default RealtimeLayer;

package/ol/mixins/MobilityLayerMixin.d.ts

@@ -7,8 +7,13 @@ type GConstructor<T = {}> = new (...args: any[]) => T;
 export type Layerable = GConstructor<Omit<Layer, keyof string>>;
 declare function MobilityLayerMixin<TBase extends Layerable>(Base: TBase): {
     new (...args: any[]): {
-        options?: PropertiesLayerMixinOptions;
         olEventsKeys: import("ol/events").EventsKey[];
+        options?: PropertiesLayerMixinOptions;
+        attachToMap(map: import("ol").Map): void;
+        detachFromMap(): void;
+        flat(): any[];
+        onChildrenChange(oldValue: Layer[]): void;
+        setMapInternal: ((map: import("ol").Map) => void) & ((map: import("ol").default | null) => void);
         children: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
         get copyrights(): string;
         set copyrights(newCopyrights: string | string[]);
@@ -21,17 +26,10 @@ declare function MobilityLayerMixin<TBase extends Layerable>(Base: TBase): {
         olLayer: Layer;
         parent: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
         visible: boolean;
-        setMapInternal: ((map: import("ol").Map) => void) & ((map: import("ol").default | null) => void);
-        onChildrenChange(oldValue: Layer[]): void;
-        attachToMap(map: import("ol").Map): void;
-        detachFromMap(): void;
-        flat(): any[];
-        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
-        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
         on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
-        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         once: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
         un: import("ol/layer/Layer").LayerOnSignature<void>;
+        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         getSource: () => import("ol/source").Source | null;
         getRenderSource: () => import("ol/source").Source | null;
         getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<Array<import("ol/Feature").FeatureLike>>;
@@ -89,9 +87,11 @@ declare function MobilityLayerMixin<TBase extends Layerable>(Base: TBase): {
         unset: (key: string, silent?: boolean | undefined) => void;
         changed: () => void;
         getRevision: () => number;
+        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
         dispatchEvent: (event: import("ol/events/Event").default | string) => boolean | undefined;
         getListeners: (type: string) => Array<import("ol/events").Listener> | undefined;
         hasListener: (type?: string | undefined) => boolean;
+        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
         dispose: () => void;
     };
 } & TBase;

package/ol/mixins/PropertiesLayerMixin.d.ts

@@ -1,31 +1,45 @@
-import { Layer } from 'ol/layer';
-import { EventsKey } from 'ol/events';
 import { Map } from 'ol';
+import { EventsKey } from 'ol/events';
+import { Layer } from 'ol/layer';
 import type { Options } from 'ol/layer/Layer';
 import type { Layerable } from './MobilityLayerMixin';
-export type PropertiesLayerMixinOptions = Options & {
-    key?: string;
-    name?: string;
-    group?: string;
-    copyrights?: string[];
+export type PropertiesLayerMixinOptions = {
     children?: any[];
-    visible?: boolean;
+    copyrights?: string[];
     disabled?: boolean;
+    group?: string;
     hitTolerance?: number;
-    properties?: {
-        [x: string]: any;
-    };
+    key?: string;
     map?: Map;
-} & {
-    [x: string]: any;
-};
+    name?: string;
+    properties?: Record<string, any>;
+    visible?: boolean;
+} & Options & Record<string, any>;
 /**
  * This mixin adds some properties to access ol custom properties easily.
  */
 declare function PropertiesLayerMixin<TBase extends Layerable>(Base: TBase): {
     new (...args: any[]): {
-        options?: PropertiesLayerMixinOptions;
         olEventsKeys: EventsKey[];
+        options?: PropertiesLayerMixinOptions;
+        /**
+         * Initialize the layer with the map passed in parameters.
+         *
+         * @param {ol/Map~Map} map A map.
+         */
+        attachToMap(map: Map): void;
+        /**
+         * Terminate what was initialized in init function. Remove layer, events...
+         */
+        detachFromMap(): void;
+        /**
+         * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
+         * @deprecated
+         */
+        flat(): any[];
+        /** @private */
+        onChildrenChange(oldValue: Layer[]): void;
+        setMapInternal(map: Map): void;
         /** @deprecated */
         children: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>[];
         /** @deprecated */
@@ -35,6 +49,7 @@ declare function PropertiesLayerMixin<TBase extends Layerable>(Base: TBase): {
         /** @deprecated */
         disabled: boolean;
         /** @deprecated */
+        /** @deprecated */
         readonly group: string;
         /** @deprecated */
         readonly hitTolerance: number;
@@ -48,30 +63,10 @@ declare function PropertiesLayerMixin<TBase extends Layerable>(Base: TBase): {
         parent: Layer<import("ol/source").Source, import("ol/renderer/Layer").default<any>>;
         /** @deprecated */
         visible: boolean;
-        setMapInternal(map: Map): void;
-        /** @private */
-        onChildrenChange(oldValue: Layer[]): void;
-        /**
-         * Initialize the layer with the map passed in parameters.
-         *
-         * @param {ol/Map~Map} map A map.
-         */
-        attachToMap(map: Map): void;
-        /**
-         * Terminate what was initialized in init function. Remove layer, events...
-         */
-        detachFromMap(): void;
-        /**
-         * Return the an array containing all the descendants of the layer in a flat array. Including the current layer.
-         * @deprecated
-         */
-        flat(): any[];
-        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
-        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
         on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
-        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         once: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
         un: import("ol/layer/Layer").LayerOnSignature<void>;
+        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         getSource: () => import("ol/source").Source | null;
         getRenderSource: () => import("ol/source").Source | null;
         getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<Array<import("ol/Feature").FeatureLike>>;
@@ -129,9 +124,11 @@ declare function PropertiesLayerMixin<TBase extends Layerable>(Base: TBase): {
         unset: (key: string, silent?: boolean | undefined) => void;
         changed: () => void;
         getRevision: () => number;
+        addEventListener: (type: string, listener: import("ol/events").Listener) => void;
         dispatchEvent: (event: import("ol/events/Event").default | string) => boolean | undefined;
         getListeners: (type: string) => Array<import("ol/events").Listener> | undefined;
         hasListener: (type?: string | undefined) => boolean;
+        removeEventListener: (type: string, listener: import("ol/events").Listener) => void;
         dispose: () => void;
     };
 } & TBase;