mobility-toolbox-js 2.0.0-beta.45 → 2.0.0-beta.47

package/common/mixins/RealtimeLayerMixin.d.ts

@@ -1,18 +1,50 @@
+import GeoJSON from 'ol/format/GeoJSON';
+import { EventsKey } from 'ol/events';
+import { Coordinate } from 'ol/coordinate';
+import { Feature } from 'ol';
+import { RealtimeAPI } from '../../api';
+import { AnyCanvas, AnyLayerClass, AnyMap, AnyRealtimeLayer, LayerGetFeatureInfoOptions, RealtimeGeneralizationLevel, RealtimeMode, RealtimeRenderState, RealtimeStyleFunction, RealtimeStyleOptions, RealtimeTenant, RealtimeTrainId, ViewState } from '../../types';
+import { RealtimeTrajectory } from '../../api/typedefs';
+import { WebSocketAPIMessageEventData } from '../api/WebSocketAPI';
+import { OlLayerOptions } from '../../ol/layers/Layer';
+export declare type RealtimeLayerMixinOptions = OlLayerOptions & {
+    debug?: boolean;
+    mode?: RealtimeMode;
+    api?: RealtimeAPI;
+    tenant?: RealtimeTenant;
+    minZoomNonTrain?: number;
+    minZoomInterpolation?: number;
+    isUpdateBboxOnMoveEnd?: boolean;
+    generalizationLevelByZoom?: RealtimeGeneralizationLevel[];
+    renderTimeIntervalByZoom?: number[];
+    style?: RealtimeStyleFunction;
+    speed?: number;
+    pixelRatio?: number;
+    hoverVehicleId?: RealtimeTrainId;
+    selectedVehicleId?: RealtimeTrainId;
+    filter?: FilterFunction;
+    sort?: SortFunction;
+    time?: number;
+    live?: boolean;
+    canvas?: HTMLCanvasElement;
+    styleOptions?: RealtimeStyleOptions;
+    useRequestAnimationFrame?: boolean;
+    useDebounce?: boolean;
+    useThrottle?: boolean;
+    getGeneralizationLevelByZoom?: (zoom: number, generalizationLevelByZoom: RealtimeGeneralizationLevel[]) => RealtimeGeneralizationLevel;
+    getRenderTimeIntervalByZoom?: (zoom: number, renderTimeIntervalByZoom: number[]) => number;
+    url?: string;
+    apiKey?: string;
+    prefix?: string;
+    projection?: string;
+    bbox?: (number | string)[];
+    buffer?: number[];
+    pingIntervalMs?: number;
+};
 /**
  * RealtimeLayerInterface.
  */
-export class RealtimeLayerInterface {
-    constructor(options?: {});
-    /**
-     * Initialize the layer subscribing to the Realtime api.
-     *
-     * @param {ol/Map~Map} map
-     */
-    attachToMap(map: any): void;
-    /**
-     * Terminate the layer unsubscribing to the Realtime api.
-     */
-    detachFromMap(): void;
+export declare class RealtimeLayerInterface {
     /**
      * Start the clock.
      */
@@ -27,13 +59,17 @@ export class RealtimeLayerInterface {
      * @param {Array<number>} extent  Extent to request, [minX, minY, maxX, maxY, zoom].
      * @param {number} zoom  Zoom level to request. Must be an integer.
      */
-    setBbox(extent: Array<number>, zoom: number): void;
+    setBbox(extent: [number, number, number, number], zoom: number): void;
     /**
      * Set the Realtime api's mode.
      *
      * @param {RealtimeMode} mode  Realtime mode
      */
     setMode(mode: RealtimeMode): void;
+    /**
+     * Render the trajectories
+     */
+    renderTrajectories(): void;
     /**
      * Request the stopSequence and the fullTrajectory informations for a vehicle.
      *
@@ -41,12 +77,8 @@ export class RealtimeLayerInterface {
      * @param {RealtimeMode} mode The mode to request. If not defined, the layer´s mode propetrty will be used.
      * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
      */
-    getTrajectoryInfos(id: string, mode: RealtimeMode): Promise<{
-        stopSequence: StopSequence;
-        fullTrajectory: FullTrajectory;
-    }>;
+    getTrajectoryInfos(id: string, mode: RealtimeMode): void;
 }
-export default RealtimeLayerMixin;
 /**
  * Mixin for RealtimeLayerInterface.
  *
@@ -54,5 +86,197 @@ export default RealtimeLayerMixin;
  * @return {Class}  A class that implements {RealtimeLayerInterface} class and extends Base;
  * @private
  */
-declare function RealtimeLayerMixin(Base: Class): Class;
+declare function RealtimeLayerMixin<T extends AnyLayerClass>(Base: T): {
+    new (options: RealtimeLayerMixinOptions): {
+        [x: string]: any;
+        debug: boolean;
+        trajectories?: {
+            [key: string]: GeoJSONFeature;
+        } | undefined;
+        canvas?: AnyCanvas | undefined;
+        mode: RealtimeMode;
+        api: RealtimeAPI;
+        tenant: RealtimeTenant;
+        time?: Date | undefined;
+        live?: boolean | undefined;
+        speed?: number | undefined;
+        filter?: Function | undefined;
+        sort?: Function | undefined;
+        style?: RealtimeStyleFunction | undefined;
+        styleOptions?: RealtimeStyleOptions | undefined;
+        pixelRatio?: number | undefined;
+        minZoomNonTrain: number;
+        minZoomInterpolation: number;
+        isUpdateBboxOnMoveEnd: boolean;
+        hoverVehicleId?: string | undefined;
+        selectedVehicleId?: string | undefined;
+        renderState?: RealtimeRenderState | undefined;
+        useRequestAnimationFrame?: boolean | undefined;
+        useDebounce?: boolean | undefined;
+        useThrottle?: boolean | undefined;
+        generalizationLevel?: RealtimeGeneralizationLevel | undefined;
+        generalizationLevelByZoom: RealtimeGeneralizationLevel[];
+        renderTimeIntervalByZoom: number[];
+        format: GeoJSON;
+        requestId?: number | undefined;
+        updateTimeInterval?: number | undefined;
+        updateTimeDelay?: number | undefined;
+        visibilityRef: EventsKey;
+        selectedVehicle: GeoJSONFeature;
+        getGeneralizationLevelByZoom: (zoom: number) => RealtimeGeneralizationLevel;
+        getRenderTimeIntervalByZoom: (zoom: number) => number;
+        throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
+        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
+        /**
+         * Define layer's properties.
+         *
+         * @ignore
+         */
+        defineProperties(options: RealtimeLayerMixinOptions): void;
+        attachToMap(map: AnyMap): void;
+        detachFromMap(): void;
+        start(): void;
+        /**
+         * Start the clock.
+         * @private
+         */
+        startUpdateTime(): void;
+        stop(): void;
+        /**
+         * Stop the clock.
+         * @private
+         */
+        stopUpdateTime(): void;
+        /**
+         * Launch renderTrajectories. it avoids duplicating code in renderTrajectories method.
+         *
+         * @param {object} viewState The view state of the map.
+         * @param {number[2]} viewState.center Center coordinate of the map in mercator coordinate.
+         * @param {number[4]} viewState.extent Extent of the map in mercator coordinates.
+         * @param {number[2]} viewState.size Size ([width, height]) of the canvas to render.
+         * @param {number} [viewState.rotation = 0] Rotation of the map to render.
+         * @param {number} viewState.resolution Resolution of the map to render.
+         * @param {boolean} noInterpolate If true trajectories are not interpolated but
+         *   drawn at the last known coordinate. Use this for performance optimization
+         *   during map navigation.
+         * @private
+         */
+        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
+        /**
+         * Render the trajectories requesting an animation frame and cancelling the previous one.
+         * This function must be overrided by children to provide the correct parameters.
+         *
+         * @param {object} viewState The view state of the map.
+         * @param {number[2]} viewState.center Center coordinate of the map in mercator coordinate.
+         * @param {number[4]} viewState.extent Extent of the map in mercator coordinates.
+         * @param {number[2]} viewState.size Size ([width, height]) of the canvas to render.
+         * @param {number} [viewState.rotation = 0] Rotation of the map to render.
+         * @param {number} viewState.resolution Resolution of the map to render.
+         * @param {boolean} noInterpolate If true trajectories are not interpolated but
+         *   drawn at the last known coordinate. Use this for performance optimization
+         *   during map navigation.
+         * @private
+         */
+        renderTrajectories(viewState: ViewState | undefined, noInterpolate: boolean | undefined): void;
+        setBbox(extent?: [number, number, number, number], zoom?: number): void;
+        setMode(mode: RealtimeMode): void;
+        /**
+         * Get the duration before the next update depending on zoom level.
+         *
+         * @private
+         * @param {number} zoom
+         */
+        getRefreshTimeInMs(zoom?: number | undefined): number;
+        /**
+         * Get vehicle.
+         * @param {function} filterFc A function use to filter results.
+         * @return {Array<Object>} Array of vehicle.
+         */
+        getVehicle(filterFc: FilterFunction): GeoJSONFeature[];
+        /**
+         * Request feature information for a given coordinate.
+         *
+         * @param {ol/coordinate~Coordinate} coordinate Coordinate.
+         * @param {Object} options Options See child classes to see which options are supported.
+         * @param {number} [options.resolution=1] The resolution of the map.
+         * @param {number} [options.nb=Infinity] The max number of vehicles to return.
+         * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
+         */
+        getFeatureInfoAtCoordinate(coordinate: Coordinate, options: LayerGetFeatureInfoOptions): Promise<{
+            layer: any;
+            features: Feature<import("ol/geom/Geometry").default>[];
+            coordinate: Coordinate;
+        }>;
+        /**
+         * Request the stopSequence and the fullTrajectory informations for a vehicle.
+         *
+         * @param {string} id The vehicle identifier (the  train_id property).
+         * @return {Promise<{stopSequence: StopSequence, fullTrajectory: FullTrajectory>} A promise that will be resolved with the trajectory informations.
+         */
+        getTrajectoryInfos(id: RealtimeTrainId): Promise<{
+            stopSequence: unknown;
+            fullTrajectory: unknown;
+        }>;
+        /**
+         * Determine if the trajectory is useless and should be removed from the list or not.
+         * By default, this function exclude vehicles:
+         *  - that have their trajectory outside the current extent and
+         *  - that are not a train and zoom level is lower than layer's minZoomNonTrain property.
+         *
+         * @param {RealtimeTrajectory} trajectory
+         * @param {Array<number>} extent
+         * @param {number} zoom
+         * @return {boolean} if the trajectory must be displayed or not.
+         * @ignore
+         */
+        purgeTrajectory(trajectory: GeoJSONFeature, extent: [number, number, number, number], zoom: number): boolean;
+        /**
+         * Add a trajectory.
+         * @param {RealtimeTrajectory} trajectory The trajectory to add.
+         * @private
+         */
+        addTrajectory(trajectory: GeoJSONFeature): void;
+        removeTrajectory(trajectoryOrId: RealtimeTrajectory | RealtimeTrainId): void;
+        /**
+         * On zoomend we adjust the time interval of the update of vehicles positions.
+         *
+         * @param evt Event that triggered the function.
+         * @private
+         */
+        onZoomEnd(): void;
+        onDocumentVisibilityChange(): void;
+        /**
+         * Callback on websocket's trajectory channel events.
+         * It adds a trajectory to the list.
+         *
+         * @private
+         */
+        onTrajectoryMessage(data: WebSocketAPIMessageEventData): void;
+        /**
+         * Callback on websocket's deleted_vehicles channel events.
+         * It removes the trajectory from the list.
+         *
+         * @private
+         * @override
+         */
+        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData): void;
+        /**
+         * Callback when user moves the mouse/pointer over the map.
+         * It sets the layer's hoverVehicleId property with the current hovered vehicle's id.
+         *
+         * @private
+         * @override
+         */
+        onFeatureHover(features: Feature[], layer: AnyRealtimeLayer, coordinate: Coordinate): void;
+        /**
+         * Callback when user clicks on the map.
+         * It sets the layer's selectedVehicleId property with the current selected vehicle's id.
+         *
+         * @private
+         * @override
+         */
+        onFeatureClick(features: Feature[], layer: AnyRealtimeLayer, coordinate: Coordinate): void;
+    };
+} & T;
+export default RealtimeLayerMixin;
 //# sourceMappingURL=RealtimeLayerMixin.d.ts.map

package/common/mixins/RealtimeLayerMixin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RealtimeLayerMixin.d.ts","sourceRoot":"","sources":["../../../src/common/mixins/RealtimeLayerMixin.js"],"names":[],"mappings":"AAgBA;;GAEG;AACH;IAYE,0BAA4B;IAE5B;;;;OAIG;IACH,4BAAmB;IAEnB;;OAEG;IACH,sBAAkB;IAElB;;OAEG;IACH,cAAU;IAEV;;OAEG;IACH,aAAS;IAET;;;;;OAKG;IACH,gBAHW,MAAM,MAAM,CAAC,QACb,MAAM,QAEO;IAExB;;;;OAIG;IACH,kCAAgB;IAEhB;;;;;;OAMG;IACH,uBAJW,MAAM,uBAEL,QAAQ;QAAC,YAAY,EAAE,YAAY,CAAC;QAAC,cAAc,EAAE,cAAc,CAAA;KAAA,CAAC,CAEjD;CAChC;;AAED;;;;;;GAMG;AACH,wDA8tBG"}
+{"version":3,"file":"RealtimeLayerMixin.d.ts","sourceRoot":"","sources":["../../../src/common/mixins/RealtimeLayerMixin.ts"],"names":[],"mappings":"AAOA,OAAO,OAAO,MAAM,mBAAmB,CAAC;AAIxC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAEtC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAE7B,OAAO,EAAE,WAAW,EAAiB,MAAM,WAAW,CAAC;AAGvD,OAAO,EACL,SAAS,EACT,aAAa,EACb,MAAM,EACN,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,EACrB,oBAAoB,EACpB,cAAc,EACd,eAAe,EACf,SAAS,EACV,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,OAAO,EAAE,4BAA4B,EAAE,MAAM,qBAAqB,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,oBAAY,yBAAyB,GAAG,cAAc,GAAG;IACvD,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,GAAG,CAAC,EAAE,WAAW,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,yBAAyB,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAC1D,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IACpC,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,eAAe,CAAC;IACjC,iBAAiB,CAAC,EAAE,eAAe,CAAC;IACpC,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,4BAA4B,CAAC,EAAE,CAC7B,IAAI,EAAE,MAAM,EACZ,yBAAyB,EAAE,2BAA2B,EAAE,KACrD,2BAA2B,CAAC;IACjC,2BAA2B,CAAC,EAAE,CAC5B,IAAI,EAAE,MAAM,EACZ,wBAAwB,EAAE,MAAM,EAAE,KAC/B,MAAM,CAAC;IAGZ,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,qBAAa,sBAAsB;IACjC;;OAEG;IACH,KAAK;IAEL;;OAEG;IACH,IAAI;IAEJ;;;;;OAKG;IACH,OAAO,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM;IAE9D;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,YAAY;IAE1B;;OAEG;IACH,kBAAkB;IAElB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;CAClD;AAED;;;;;;GAMG;AACH,iBAAS,kBAAkB,CAAC,CAAC,SAAS,aAAa,EAAE,IAAI,EAAE,CAAC;kBAiFnC,yBAAyB;;eA9EvC,OAAO;;;;;cAMR,YAAY;aAEb,WAAW;gBAER,cAAc;;;;;;;;;yBAkBL,MAAM;8BAED,MAAM;+BAEL,OAAO;;;;;;;;mCAgBH,2BAA2B,EAAE;kCAE9B,MAAM,EAAE;gBAE1B,OAAO;;;;uBAQC,SAAS;;6CAIY,MAAM,KAAK,2BAA2B;4CAEvC,MAAM,KAAK,MAAM;gDAGxC,SAAS,kBACJ,OAAO,KACpB,IAAI;gDAGI,SAAS,kBACJ,OAAO,KACpB,IAAI;QAyET;;;;WAIG;kCACuB,yBAAyB;yBAmKlC,MAAM;;;QAiEvB;;;WAGG;;;QAsBH;;;WAGG;;QAQH;;;;;;;;;;;;;WAaG;8CAEU,SAAS,kBACL,OAAO;QA6CxB;;;;;;;;;;;;;;WAcG;sCAEU,SAAS,GAAG,SAAS,iBACjB,OAAO,GAAG,SAAS;yBAwBnB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,SAAS,MAAM;sBAmClD,YAAY;QAiB1B;;;;;WAKG;kCACsB,MAAM,GAAG,SAAS,GAAO,MAAM;QA0BxD;;;;WAIG;6BACkB,cAAc;QASnC;;;;;;;;WAQG;oEAGQ,0BAA0B;;;;;QAkCrC;;;;;WAKG;+BACoB,eAAe;;;;QAiBtC;;;;;;;;;;;WAWG;4DAGO,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,QAClC,MAAM;QAad;;;;WAIG;;yCAa8B,kBAAkB,GAAG,eAAe;QAYrE;;;;;WAKG;;;QAgBH;;;;;WAKG;kCACuB,4BAA4B;QA+CtD;;;;;;WAMG;wCAC6B,4BAA4B;QAO5D;;;;;;WAMG;iCAES,OAAO,EAAE,SACZ,gBAAgB;QAgBzB;;;;;;WAMG;iCAES,OAAO,EAAE,SACZ,gBAAgB;;MAkB5B;AAED,eAAe,kBAAkB,CAAC"}