mobility-toolbox-js 3.0.0-beta.9 → 3.0.0

package/ol/layers/RealtimeLayer.d.ts

@@ -1,186 +1,25 @@
-import GeoJSON from 'ol/format/GeoJSON';
-import Source from 'ol/source/Source';
-import Feature, { FeatureLike } from 'ol/Feature';
+import { DebouncedFunc } from 'lodash';
 import { Map, MapEvent } from 'ol';
-import { ObjectEvent } from 'ol/Object';
+import { EventsKey } from 'ol/events';
+import Feature, { FeatureLike } from 'ol/Feature';
 import Layer from 'ol/layer/Layer';
-import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
-import { RealtimeFullTrajectory, RealtimeTrainId, ViewState } from '../../types';
-import { RealtimeTrajectory } from '../../api/typedefs';
+import VectorLayer from 'ol/layer/Vector';
+import { ObjectEvent } from 'ol/Object';
+import { Vector as VectorSource } from 'ol/source';
+import { State } from 'ol/View';
 import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
+import { FilterFunction, SortFunction } from '../../common/typedefs';
+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 & {
-    fullTrajectoryStyle?: (feature: FeatureLike, resolution: number, options: any) => void;
+export type RealtimeLayerOptions = {
     allowRenderWhenAnimating?: boolean;
-};
-declare const RealtimeLayer_base: {
-    new (options: RealtimeLayerMixinOptions): {
-        [x: string]: any;
-        debug: boolean;
-        trajectories?: {
-            [key: string]: GeoJSONFeature;
-        } | undefined;
-        canvas?: import("../../types").AnyCanvas | undefined;
-        mode: import("../../types").RealtimeMode;
-        api: import("../../api/RealtimeAPI").default;
-        tenant: string;
-        bboxParameters?: {
-            [index: string]: string | number | boolean | string[] | number[] | boolean[];
-        } | undefined;
-        time?: Date | undefined;
-        live?: boolean | undefined;
-        speed?: number | undefined;
-        filter?: Function | undefined;
-        sort?: Function | undefined;
-        style?: import("../../types").RealtimeStyleFunction | undefined;
-        styleOptions?: import("../../types").RealtimeStyleOptions | undefined;
-        pixelRatio?: number | undefined;
-        minZoomInterpolation: number;
-        isUpdateBboxOnMoveEnd: boolean;
-        hoverVehicleId?: string | undefined;
-        selectedVehicleId?: string | undefined;
-        renderState?: import("../../types").RealtimeRenderState | undefined;
-        useRequestAnimationFrame?: boolean | undefined;
-        useDebounce?: boolean | undefined;
-        useThrottle?: boolean | undefined;
-        mots?: import("../../types").RealtimeMot[] | undefined;
-        motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
-        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
-        renderTimeIntervalByZoom: number[];
-        format: GeoJSON<typeof Feature>;
-        requestId?: number | undefined;
-        updateTimeInterval?: number | undefined;
-        updateTimeDelay?: number | undefined;
-        visibilityRef: import("ol/events").EventsKey;
-        selectedVehicle: GeoJSONFeature;
-        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
-        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
-        getRenderTimeIntervalByZoom: (zoom: number) => number;
-        throttleRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean | undefined) => void;
-        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean | undefined) => void;
-        onStart?: ((realtimeLayer: any) => void) | undefined;
-        onStop?: ((realtimeLayer: any) => void) | undefined;
-        defineProperties(options: RealtimeLayerMixinOptions): void;
-        attachToMap(map: any): void;
-        detachFromMap(): void;
-        start(): void;
-        startUpdateTime(): void;
-        stop(): void;
-        stopUpdateTime(): void;
-        renderTrajectoriesInternal(viewState: ViewState, noInterpolate?: boolean): boolean;
-        renderTrajectories(viewState: ViewState | undefined, noInterpolate: boolean | undefined): void;
-        setBbox(extent: [number, number, number, number], zoom: number): void;
-        getRefreshTimeInMs(zoom?: number | undefined): number;
-        getVehicle(filterFc: Function): GeoJSONFeature[];
-        getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
-        getTrajectoryInfos(id: string): Promise<{
-            stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
-            fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<GeoJSONFeature[]>;
-        }>;
-        purgeOutOfDateTrajectories(): void;
-        purgeTrajectory(trajectory: GeoJSONFeature, extent: [number, number, number, number], zoom: number): boolean;
-        addTrajectory(trajectory: GeoJSONFeature): void;
-        removeTrajectory(trajectoryOrId: any): void;
-        onZoomEnd(): void;
-        onDocumentVisibilityChange(): void;
-        onTrajectoryMessage(data: WebSocketAPIMessageEventData<GeoJSONFeature>): void;
-        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<string>): void;
-        highlightVehicle(id: string): void;
-        selectVehicle(id: string): void;
-    };
-} & {
-    new (...args: any[]): {
-        options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions | undefined;
-        olListenersKeys: import("ol/events").EventsKey[];
-        children: Layer<Source, import("ol/renderer/Layer").default<any>>[];
-        get copyrights(): string;
-        set copyrights(newCopyrights: string | string[]);
-        disabled: boolean;
-        readonly group: string;
-        readonly hitTolerance: boolean;
-        readonly key: string;
-        readonly map: Map;
-        readonly name: string;
-        olLayer: Layer<Source, import("ol/renderer/Layer").default<any>>;
-        parent: Layer<Source, import("ol/renderer/Layer").default<any>>;
-        visible: boolean;
-        setMapInternal: ((map: Map) => void) & ((map: Map | null) => void);
-        onChildrenChange(oldValue: Layer<Source, import("ol/renderer/Layer").default<any>>[]): void;
-        attachToMap(map: 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>;
-        getSource: () => Source | null;
-        getRenderSource: () => Source | null;
-        getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<FeatureLike[]>;
-        getData: (pixel: import("ol/pixel").Pixel) => Float32Array | Uint8ClampedArray | Uint8Array | DataView | null;
-        isVisible: (view?: import("ol/View").default | import("ol/View").ViewStateLayerStateExtent | undefined) => boolean;
-        getAttributions: (view?: import("ol/View").default | import("ol/View").ViewStateLayerStateExtent | undefined) => string[];
-        unrender: () => void;
-        getDeclutter: () => string;
-        renderDeclutter: (frameState: import("ol/Map").FrameState, layerState: import("ol/layer/Layer").State) => void;
-        renderDeferred: (frameState: import("ol/Map").FrameState) => void;
-        getMapInternal: () => Map | null;
-        setMap: (map: Map | null) => void;
-        setSource: (source: Source | null) => void;
-        getRenderer: () => import("ol/renderer/Layer").default<any> | null;
-        hasRenderer: () => boolean;
-        getBackground: () => false | import("ol/layer/Base").BackgroundColor;
-        getClassName: () => string;
-        getLayerState: (managed?: boolean | undefined) => import("ol/layer/Layer").State;
-        getLayersArray: (array?: Layer<Source, import("ol/renderer/Layer").default<any>>[] | undefined) => Layer<Source, import("ol/renderer/Layer").default<any>>[];
-        getLayerStatesArray: (states?: import("ol/layer/Layer").State[] | undefined) => import("ol/layer/Layer").State[];
-        getExtent: () => import("ol/extent").Extent | undefined;
-        getMaxResolution: () => number;
-        getMinResolution: () => number;
-        getMinZoom: () => number;
-        getMaxZoom: () => number;
-        getOpacity: () => number;
-        getSourceState: () => import("ol/source/Source").State;
-        getVisible: () => boolean;
-        getZIndex: () => number | undefined;
-        setBackground: (background?: import("ol/layer/Base").BackgroundColor | undefined) => void;
-        setExtent: (extent: import("ol/extent").Extent | undefined) => void;
-        setMaxResolution: (maxResolution: number) => void;
-        setMinResolution: (minResolution: number) => void;
-        setMaxZoom: (maxZoom: number) => void;
-        setMinZoom: (minZoom: number) => void;
-        setOpacity: (opacity: number) => void;
-        setVisible: (visible: boolean) => void;
-        setZIndex: (zindex: number) => void;
-        get: (key: string) => any;
-        getKeys: () => string[];
-        getProperties: () => {
-            [x: string]: any;
-        };
-        getPropertiesInternal: () => {
-            [x: string]: any;
-        } | null;
-        hasProperties: () => boolean;
-        notify: (key: string, oldValue: any) => void;
-        addChangeListener: (key: string, listener: import("ol/events").Listener) => void;
-        removeChangeListener: (key: string, listener: import("ol/events").Listener) => void;
-        set: (key: string, value: any, silent?: boolean | undefined) => void;
-        setProperties: (values: {
-            [x: string]: any;
-        }, silent?: boolean | undefined) => void;
-        unset: (key: string, silent?: boolean | undefined) => void;
-        changed: () => void;
-        getRevision: () => number;
-        dispatchEvent: (event: string | import("ol/events/Event").default) => boolean | undefined;
-        getListeners: (type: string) => import("ol/events").Listener[] | undefined;
-        hasListener: (type?: string | undefined) => boolean;
-        dispose: () => void;
-    };
-} & typeof Layer;
+    fullTrajectoryStyle?: (feature: FeatureLike, resolution: number, options: any) => void;
+    maxNbFeaturesRequested?: number;
+} & RealtimeEngineOptions;
 /**
- * Responsible for loading and display data from the geOps realtime API.
+ * An OpenLayers layer able to display data from the [geOps Realtime API](https://developer.geops.io/apis/realtime/).
  *
  * @example
  * import { RealtimeLayer } from 'mobility-toolbox-js/ol';
@@ -193,93 +32,119 @@ declare const RealtimeLayer_base: {
  *
  *
  * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ * @see <a href="/example/ol-realtime">OpenLayers Realtime layer example</a>
+ *
  *
  * @extends {ol/layer/Layer~Layer}
  *
+ *
  * @classproperty {boolean} allowRenderWhenAnimating - Allow rendering of the layer when the map is animating.
  * @public
  */
-declare class RealtimeLayer extends RealtimeLayer_base {
-    /** @private */
+declare class RealtimeLayer extends Layer {
     allowRenderWhenAnimating?: boolean;
+    currentZoom?: number;
+    engine: RealtimeEngine;
+    maxNbFeaturesRequested: number;
+    olEventsKeys: EventsKey[];
+    onMoveEndDebounced: DebouncedFunc<(evt: MapEvent | ObjectEvent) => void>;
+    onZoomEndDebounced: DebouncedFunc<(evt: MapEvent | ObjectEvent) => void>;
+    renderedViewState: State | undefined;
+    vectorLayer: VectorLayer<VectorSource>;
+    get api(): RealtimeAPI;
+    set api(api: RealtimeAPI);
+    get canvas(): import("../../types").AnyCanvas | undefined;
+    get filter(): FilterFunction | undefined;
+    set filter(filter: FilterFunction);
+    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(): SortFunction | undefined;
+    set sort(sort: SortFunction);
+    get trajectories(): Record<string, import("../../types").RealtimeTrajectory> | undefined;
     /**
      * 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.
+     * @public
      */
     constructor(options: RealtimeLayerOptions);
+    attachToMap(): void;
     /**
-     * @private
+     * Create a copy of the RealtimeLayer.
+     *
+     * @param {Object} newOptions Options to override. See constructor.
+     * @return {RealtimeLayer} A RealtimeLayer
+     * @public
      */
+    clone(newOptions: RealtimeLayerOptions): RealtimeLayer;
     createRenderer(): RealtimeLayerRenderer;
-    /** @private */
-    attachToMap(map: Map): void;
     /**
      * Destroy the container of the tracker.
-     * @private
      */
     detachFromMap(): void;
     /**
-     * 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
-     */
-    renderTrajectories(noInterpolate: boolean): void;
-    /**
-     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
-     * @private
-     * @override
-     */
-    renderTrajectoriesInternal(viewState: ViewState, noInterpolate: boolean): boolean;
-    /**
-     * Return the delay in ms before the next rendering.
-     * @private
+     * Get some informations about a trajectory.
+     *
+     * @param {RealtimeTrainId} id A vehicle's id.
+     * @returns
      */
-    getRefreshTimeInMs(): number;
+    getTrajectoryInfos(id: RealtimeTrainId): Promise<{
+        fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+        stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+    }>;
+    getVehicles(filterFunc: FilterFunction): import("../../types").RealtimeTrajectory[];
+    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;
     /**
-     * On move end we update the websocket with the new bbox.
-     *
-     * @private
-     * @override
+     * Highlight the trajectory of journey.
      */
-    onMoveEnd(evt: MapEvent | ObjectEvent): void;
+    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.
      */
+    onRealtimeEngineRender(renderState: RealtimeRenderState, viewState: ViewState): void;
     onZoomEnd(): void;
-    highlight(feature: Feature): void;
     select(feature: Feature): void;
+    setMapInternal(map: Map): void;
+    shouldRender(): boolean | undefined;
     /**
-     * Remove the trajectory form the list if necessary.
+     * Start the rendering.
      *
-     * @private
+     * @public
      */
-    purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
+    start(): void;
     /**
-     * Send the current bbox to the websocket
+     * Stop the rendering.
      *
-     * @private
+     * @public
      */
-    setBbox(extent?: [number, number, number, number], zoom?: number): void;
-    /**
-     * Highlight the trajectory of journey.
-     * @private
-     */
-    highlightTrajectory(id: RealtimeTrainId): Promise<Feature[] | undefined>;
-    /**
-     * Create a copy of the RealtimeLayer.
-     * @param {Object} newOptions Options to override
-     * @return {RealtimeLayer} A RealtimeLayer
-     */
-    clone(newOptions: RealtimeLayerOptions): RealtimeLayer;
+    stop(): void;
 }
 export default RealtimeLayer;