mobility-toolbox-js 3.0.0-beta.31 → 3.0.0-beta.33

package/ol/layers/MaplibreStyleLayer.js

@@ -13,33 +13,38 @@ if (typeof window !== 'undefined' &&
     }, 1000);
 }
 /**
- * Layer for visualizing a specific set of layer from a MapboxLayer.
+ * Layer that helps show/hide a specific subset of style layers of a [MaplibreLayer](./MaplibreLayer.js~MaplibreLayer.html).
  *
  * @example
- * import { MapboxLayer, MapboxStyleLayer } from 'mobility-toolbox-js/ol';
+ * import { MaplibreLayer, MaplibreStyleLayer } from 'mobility-toolbox-js/ol';
  *
- * const maplibreLayer = new MapboxLayer({
- *   url: 'https://maps.geops.io/styles/travic_v2/style.json?key=[yourApiKey]',
+ * const maplibreLayer = new MaplibreLayer({
+ *   apiKey: 'yourApiKey',
  * });
  *
- * const layer = new MapboxStyleLayer({
+ * const layer = new MaplibreStyleLayer({
  *   maplibreLayer: maplibreLayer,
- *   styleLayersFilter: () => {},
+ *   layersFilter: (layer) => {
+ *     // show/hide only style layers related to stations
+ *     return /station/.test(layer.id);
+ *   },
  * });
  *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
  * @extends {ol/layer/Layer~Layer}
+ * @public
  */
 class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     /**
      * Constructor.
      *
      * @param {Object} options
-     * @param {MapboxLayer} [options.maplibreLayer] The MaplibreLayer to use.
-     * @param {maplibregl.SourceSpecification[]} [options.sources] The source to add to the style on load.
+     * @param {string} [options.beforeId] The style layer id to use when the options.layers property is defined, unsused otherwise.
      * @param {maplibregl.AddLayerObject[]} [options.layers] The layers to add to the style on load.
      * @param {FilterFunction} [options.layersFilter] Filter function to decide which style layer to apply visiblity on. If not provided, the 'layers' property is used.
+     * @param {MaplibreLayer} [options.maplibreLayer] The MaplibreLayer to use.
      * @param {FilterFunction} [options.queryRenderedLayersFilter] Filter function to decide which style layer are available for query.
+     * @param {maplibregl.SourceSpecification[]} [options.sources] The sources to add to the style on load.
+     * @public
      */
     constructor(options = {
         mapLibreOptions: { style: { layers: [], sources: {}, version: 8 } },
@@ -69,9 +74,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         super(Object.assign({ source: new Source({}) }, options));
         this.highlightedFeatures = [];
         this.selectedFeatures = [];
-        /**
-         * @private
-         */
+        this.beforeId = options.beforeId;
         this.onLoad = this.onLoad.bind(this);
         if (!this.layersFilter && this.layers) {
             this.layersFilter = (layer) => {
@@ -79,7 +82,6 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
             };
         }
     }
-    /** @private */
     addLayers() {
         var _a;
         if (!((_a = this.maplibreLayer) === null || _a === void 0 ? void 0 : _a.mapLibreMap) || !Array.isArray(this.layers)) {
@@ -99,7 +101,6 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
             this.applyLayoutVisibility();
         }
     }
-    /** @private */
     addSources() {
         var _a;
         if (!((_a = this.maplibreLayer) === null || _a === void 0 ? void 0 : _a.mapLibreMap) || !this.sources) {
@@ -198,9 +199,11 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         }));
     }
     /**
-     * Create a copy of the MapboxStyleLayer.
-     * @param {Object} newOptions Options to override.
-     * @return {MapboxStyleLayer} A MapboxStyleLayer.
+     * Create a copy of the MaplibreStyleLayer.
+     *
+     * @param {Object} newOptions Options to override. See constructor.
+     * @return {MapboxStyleLayer} A MaplibreStyleLayer.
+     * @public
      */
     clone(newOptions) {
         return new MaplibreStyleLayer(Object.assign(Object.assign({}, this.options), newOptions));
@@ -225,6 +228,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * Request feature information for a given coordinate.
      * @param {ol/coordinate~Coordinate} coordinate Coordinate to request the information at.
      * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
+     * @deprecated Use getFeatureInfoAtCoordinate([layer], coordinate) from mobility-toolbox-ol package instead.
      */
     getFeatureInfoAtCoordinate(coordinate) {
         var _a;
@@ -275,11 +279,11 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     /**
      * Highlight a list of features.
      * @param {Array<ol/Feature~Feature>} [features=[]] Features to highlight.
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     highlight(features = []) {
         var _a;
-        deprecated(`Deprecated. Use layer.setFeatureState(features, {highlighted: true}) instead.`);
+        deprecated(`Deprecated. Use layer.setFeatureState(features, {hover: true}) instead.`);
         // Filter out selected features
         const filtered = ((_a = this.highlightedFeatures) === null || _a === void 0 ? void 0 : _a.filter((feature) => !(this.selectedFeatures || [])
             .map((feat) => feat.getId())
@@ -292,7 +296,6 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     }
     /**
      * On Maplibre map load callback function. Add style layers and dynaimc filters.
-     * @private
      */
     onLoad() {
         var _a;
@@ -309,7 +312,6 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         }
         this.applyLayoutVisibility();
     }
-    /** @private */
     removeLayers() {
         var _a;
         if (!((_a = this.maplibreLayer) === null || _a === void 0 ? void 0 : _a.mapLibreMap) || !Array.isArray(this.layers)) {
@@ -325,7 +327,6 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
             });
         }
     }
-    /** @private */
     removeSources() {
         var _a;
         if (!((_a = this.maplibreLayer) === null || _a === void 0 ? void 0 : _a.mapLibreMap) || !this.sources) {
@@ -343,7 +344,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     /**
      * Select a list of features.
      * @param {Array<ol/Feature~Feature>} [features=[]] Features to select.
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {selected: true|false}) instead.
      */
     select(features = []) {
         deprecated(`Deprecated. Use layer.setFeatureState(features, {selected: true}) instead.`);
@@ -353,8 +354,9 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     }
     /**
      * Set the feature state of the features.
-     * @param {Array<ol/Feature~Feature>} features
-     * @param {{[key:string]:boolean}} state The feature state
+     *
+     * @param {ol/Feature~Feature[]} features
+     * @param {maplibregl.FeatureState} state The feature state
      * @public
      */
     setFeatureState(features, state) {
@@ -382,7 +384,7 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
      * Set if features are hovered or not.
      * @param {Array<ol/Feature~Feature>} features
      * @param {boolean} state Is the feature hovered
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     setHoverState(features, state) {
         deprecated(`Deprecated. Use layer.setFeatureState(features, {hover: ${state}}) instead.`);
@@ -406,6 +408,9 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
     set layersFilter(newValue) {
         this.set('layersFilter', newValue);
     }
+    /**
+     * @deprecated Use MaplibreStyleLayer.maplibreLayer instead.
+     */
     get mapboxLayer() {
         deprecated('Deprecated. Use maplibreLayer instead.');
         return this.get('maplibreLayer');
@@ -445,10 +450,10 @@ class MaplibreStyleLayer extends MobilityLayerMixin(Layer) {
         this.set('sources', newValue);
     }
     /**
-     * @deprecated
+     * @deprecated Use MaplibreStyleLayer.layer instead.
      */
     get styleLayer() {
-        deprecated('MaplibreStyleLayer.styleLayer is deprecated. Use MaplibreStyleLayer.layer instead.');
+        deprecated('Deprecated. Use MaplibreStyleLayer.layer instead.');
         return this.layers[0];
     }
     /**

package/ol/layers/RealtimeLayer.d.ts

@@ -1,92 +1,23 @@
+import { DebouncedFunc } from 'lodash';
 import { Map, MapEvent } from 'ol';
 import Feature, { FeatureLike } from 'ol/Feature';
-import GeoJSON from 'ol/format/GeoJSON';
 import { Vector as VectorLayer } from 'ol/layer';
 import Layer from 'ol/layer/Layer';
 import { ObjectEvent } from 'ol/Object';
+import { Vector as VectorSource } from 'ol/source';
 import Source from 'ol/source/Source';
+import { State } from 'ol/View';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
-import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
-import { RealtimeFullTrajectory, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
+import RealtimeEngine, { RealtimeEngineOptions } from '../../common/utils/RealtimeEngine';
+import { RealtimeAPI } from '../../maplibre';
+import { RealtimeFullTrajectory, RealtimeMode, RealtimeRenderState, RealtimeTrainId, ViewState } from '../../types';
 import RealtimeLayerRenderer from '../renderers/RealtimeLayerRenderer';
-export type RealtimeLayerOptions = RealtimeLayerMixinOptions & {
+export type RealtimeLayerOptions = {
     allowRenderWhenAnimating?: boolean;
     fullTrajectoryStyle?: (feature: FeatureLike, resolution: number, options: any) => void;
-};
+    maxNbFeaturesRequested?: number;
+} & RealtimeEngineOptions;
 declare const RealtimeLayer_base: {
-    new (options: RealtimeLayerMixinOptions): {
-        [x: string]: any;
-        [x: symbol]: any;
-        api: import("..").RealtimeAPI;
-        bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
-        canvas?: import("../../types").AnyCanvas;
-        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        debug: boolean;
-        filter?: import("../../common/typedefs").FilterFunction;
-        format: GeoJSON;
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel;
-        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
-        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
-        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
-        getRenderTimeIntervalByZoom: (zoom: number) => number;
-        hoverVehicleId?: RealtimeTrainId;
-        isUpdateBboxOnMoveEnd: boolean;
-        live?: boolean;
-        minZoomInterpolation: number;
-        mode: import("../../types").RealtimeMode;
-        mots?: import("../../types").RealtimeMot[];
-        motsByZoom: import("../../types").RealtimeMot[][];
-        onStart?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        onStop?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        pixelRatio?: number;
-        renderState?: import("../../types").RealtimeRenderState;
-        renderTimeIntervalByZoom: number[];
-        requestId?: number;
-        selectedVehicle: RealtimeTrajectory;
-        selectedVehicleId?: RealtimeTrainId;
-        sort?: import("../../common/typedefs").SortFunction;
-        speed?: number;
-        style?: import("../../types").RealtimeStyleFunction;
-        styleOptions?: import("../../types").RealtimeStyleOptions;
-        tenant: import("../../types").RealtimeTenant;
-        throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        time?: Date;
-        trajectories?: Record<RealtimeTrainId, RealtimeTrajectory>;
-        updateTimeDelay?: number;
-        updateTimeInterval?: number;
-        useDebounce?: boolean;
-        useRequestAnimationFrame?: boolean;
-        useThrottle?: boolean;
-        visibilityRef: import("ol/events").EventsKey;
-        addTrajectory(trajectory: RealtimeTrajectory): void;
-        attachToMap(map: import("../../types").AnyMap): void;
-        defineProperties(options: RealtimeLayerMixinOptions): void;
-        detachFromMap(): void;
-        getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
-        getRefreshTimeInMs(zoom?: number | undefined): number;
-        getTrajectoryInfos(id: RealtimeTrainId): Promise<{
-            fullTrajectory: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<RealtimeFullTrajectory>;
-            stopSequence: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<RealtimeFullTrajectory>;
-        }>;
-        getVehicle(filterFc: import("../../common/typedefs").FilterFunction): RealtimeTrajectory[];
-        highlightVehicle(id: RealtimeTrainId): void;
-        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrainId>): void;
-        onDocumentVisibilityChange(): void;
-        onTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrajectory>): void;
-        onZoomEnd(): void;
-        purgeOutOfDateTrajectories(): void;
-        purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
-        removeTrajectory(trajectoryOrId: RealtimeTrainId | RealtimeTrajectory): void;
-        renderTrajectories(viewState: undefined | ViewState, noInterpolate: boolean | undefined): void;
-        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
-        selectVehicle(id: RealtimeTrainId): void;
-        setBbox(extent: [number, number, number, number], zoom: number): void;
-        start(): void;
-        startUpdateTime(): void;
-        stop(): void;
-        stopUpdateTime(): void;
-    };
-} & {
     new (...args: any[]): {
         olEventsKeys: import("ol/events").EventsKey[];
         options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions;
@@ -197,87 +128,104 @@ declare const RealtimeLayer_base: {
  * @public
  */
 declare class RealtimeLayer extends RealtimeLayer_base {
-    /** @private */
     allowRenderWhenAnimating?: boolean;
-    vectorLayer: VectorLayer<Feature>;
+    currentZoom?: number;
+    engine: RealtimeEngine;
+    maxNbFeaturesRequested: number;
+    onMoveEndDebounced: DebouncedFunc<(evt: MapEvent | ObjectEvent) => void>;
+    onZoomEndDebounced: DebouncedFunc<(evt: MapEvent | ObjectEvent) => void>;
+    renderedViewState: State | undefined;
+    vectorLayer: VectorLayer<VectorSource>;
     /**
      * Constructor.
      *
      * @param {RealtimeLayerOptions} options
      * @param {boolean} [options.allowRenderWhenAnimating=false] Allow rendering of the layer when the map is animating.
-     * @param {string} options.apiKey Access key for [geOps apis](https://developer.geops.io/).
-     * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The geOps Realtime API url.
+     * @param {string} options.apiKey Access key for [geOps APIs](https://developer.geops.io/).
+     * @param {string} [options.url="wss://api.geops.io/tracker-ws/v1/"] The [geOps Realtime API](https://developer.geops.io/apis/realtime/) url.
      *
      */
     constructor(options: RealtimeLayerOptions);
-    /** @private */
     attachToMap(map: Map): void;
     /**
      * Create a copy of the RealtimeLayer.
-     * @param {Object} newOptions Options to override
+     *
+     * @param {Object} newOptions Options to override. See constructor.
      * @return {RealtimeLayer} A RealtimeLayer
+     * @public
      */
     clone(newOptions: RealtimeLayerOptions): RealtimeLayer;
-    /**
-     * @private
-     */
     createRenderer(): RealtimeLayerRenderer;
-    /**
-     * Render the trajectories using current map's size, resolution and rotation.
-     * @param {boolean} noInterpolate if true, renders the vehicles without interpolating theirs positions.
-     * @overrides
-     * @private
-     */
     /**
      * Destroy the container of the tracker.
-     * @private
      */
     detachFromMap(): void;
     /**
-     * Return the delay in ms before the next rendering.
-     * @private
-     */
-    getRefreshTimeInMs(): number;
-    highlight(feature: Feature): void;
-    /**
-     * On move end we update the websocket with the new bbox.
+     * Get some informations about a trajectory.
      *
-     * @private
-     * @override
+     * @param {RealtimeTrainId} id A vehicle's id.
+     * @returns
      */
+    getTrajectoryInfos(id: RealtimeTrainId): Promise<{
+        fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+        stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+    }>;
+    getViewState(): {
+        center?: undefined;
+        extent?: undefined;
+        pixelRatio?: undefined;
+        resolution?: undefined;
+        rotation?: undefined;
+        size?: undefined;
+        visible?: undefined;
+        zoom?: undefined;
+    } | {
+        center: import("ol/coordinate").Coordinate | undefined;
+        extent: import("ol/extent").Extent;
+        pixelRatio: number | undefined;
+        resolution: number | undefined;
+        rotation: number;
+        size: import("ol/size").Size | undefined;
+        visible: boolean;
+        zoom: number | undefined;
+    };
+    highlight(feature: Feature): void;
     /**
      * Highlight the trajectory of journey.
-     * @private
      */
     highlightTrajectory(id: RealtimeTrainId): Promise<Feature[] | undefined>;
+    onMoveEnd(): void;
     /**
-     * Function called on moveend event only when the zoom has changed.
-     *
-     * @param {ol/MapEvent~MapEvent} evt Moveend event.
-     * @private
-     * @override
+     * Callback when the RealtimeEngine has rendered successfully.
      */
-    onMoveEnd(evt: MapEvent | ObjectEvent): void;
+    onRealtimeEngineRender(renderState: RealtimeRenderState, viewState: ViewState): void;
     onZoomEnd(): void;
+    select(feature: Feature): void;
+    shouldRender(): boolean;
     /**
-     * Remove the trajectory form the list if necessary.
+     * Start the rendering.
      *
-     * @private
-     */
-    purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
-    renderTrajectories(noInterpolate: boolean): void;
-    /**
-     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
-     * @private
-     * @override
+     * @public
      */
-    renderTrajectoriesInternal(viewState: ViewState, noInterpolate: boolean): boolean;
-    select(feature: Feature): void;
+    start(): void;
     /**
-     * Send the current bbox to the websocket
+     * Stop the rendering.
      *
-     * @private
+     * @public
      */
-    setBbox(extent?: [number, number, number, number], zoom?: number): void;
+    stop(): void;
+    get api(): RealtimeAPI;
+    set api(api: RealtimeAPI);
+    get canvas(): import("../../types").AnyCanvas | undefined;
+    get filter(): Function | undefined;
+    get hoverVehicleId(): RealtimeTrainId | undefined;
+    set hoverVehicleId(id: RealtimeTrainId);
+    get mode(): RealtimeMode;
+    set mode(mode: RealtimeMode);
+    get pixelRatio(): number | undefined;
+    get selectedVehicleId(): RealtimeTrainId | undefined;
+    set selectedVehicleId(id: RealtimeTrainId);
+    get sort(): Function | undefined;
+    get trajectories(): Record<string, import("../../types").RealtimeTrajectory> | undefined;
 }
 export default RealtimeLayer;