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

package/ol/layers/RealtimeLayer.d.ts

@@ -1,99 +1,100 @@
+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 Source from 'ol/source/Source';
-import Feature, { FeatureLike } from 'ol/Feature';
-import { Map, MapEvent } from 'ol';
-import { ObjectEvent } from 'ol/Object';
 import Layer from 'ol/layer/Layer';
+import { ObjectEvent } from 'ol/Object';
+import Source from 'ol/source/Source';
+import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
 import { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
 import { RealtimeFullTrajectory, RealtimeTrainId, RealtimeTrajectory, ViewState } from '../../types';
-import { WebSocketAPIMessageEventData } from '../../api/WebSocketAPI';
 import RealtimeLayerRenderer from '../renderers/RealtimeLayerRenderer';
-export type RealtimeLayerOptions = RealtimeLayerMixinOptions & {
-    fullTrajectoryStyle?: (feature: FeatureLike, resolution: number, options: any) => void;
+export type RealtimeLayerOptions = {
     allowRenderWhenAnimating?: boolean;
-};
+    fullTrajectoryStyle?: (feature: FeatureLike, resolution: number, options: any) => void;
+} & RealtimeLayerMixinOptions;
 declare const RealtimeLayer_base: {
     new (options: RealtimeLayerMixinOptions): {
         [x: string]: any;
         [x: symbol]: any;
-        debug: boolean;
-        trajectories?: {
-            [key: string]: RealtimeTrajectory;
-        } | undefined;
-        canvas?: import("../../types").AnyCanvas;
-        mode: import("../../types").RealtimeMode;
         api: import("..").RealtimeAPI;
-        tenant: import("../../types").RealtimeTenant;
-        bboxParameters?: {
-            [index: string]: string | number | boolean | string[] | number[] | boolean[];
-        } | undefined;
-        time?: Date;
-        live?: boolean;
-        speed?: number;
+        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;
-        sort?: import("../../common/typedefs").SortFunction;
-        style?: import("../../types").RealtimeStyleFunction;
-        styleOptions?: import("../../types").RealtimeStyleOptions;
-        pixelRatio?: number;
-        minZoomInterpolation: number;
-        isUpdateBboxOnMoveEnd: boolean;
+        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;
-        selectedVehicleId?: RealtimeTrainId;
-        renderState?: import("../../types").RealtimeRenderState;
-        useRequestAnimationFrame?: boolean;
-        useDebounce?: boolean;
-        useThrottle?: boolean;
+        isUpdateBboxOnMoveEnd: boolean;
+        live?: boolean;
+        minZoomInterpolation: number;
+        mode: import("../../types").RealtimeMode;
         mots?: import("../../types").RealtimeMot[];
         motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel;
-        generalizationLevelByZoom: import("../../types").RealtimeGeneralizationLevel[];
+        onStart?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
+        onStop?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
+        pixelRatio?: number;
+        renderState?: import("../../types").RealtimeRenderState;
         renderTimeIntervalByZoom: number[];
-        format: GeoJSON;
         requestId?: number;
-        updateTimeInterval?: number;
-        updateTimeDelay?: number;
-        visibilityRef: import("ol/events").EventsKey;
         selectedVehicle: RealtimeTrajectory;
-        getMotsByZoom: (zoom: number) => import("../../types").RealtimeMot[];
-        getGeneralizationLevelByZoom: (zoom: number) => import("../../types").RealtimeGeneralizationLevel;
-        getRenderTimeIntervalByZoom: (zoom: number) => number;
+        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;
-        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
-        onStart?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        onStop?: ((realtimeLayer: import("../../types").AnyLayer) => void) | undefined;
-        defineProperties(options: RealtimeLayerMixinOptions): 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;
-        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: import("../../common/typedefs").FilterFunction): RealtimeTrajectory[];
         getFeatureInfoAtCoordinate(coordinate: import("ol/coordinate").Coordinate, options: import("../../types").LayerGetFeatureInfoOptions): Promise<import("../../types").LayerGetFeatureInfoResponse>;
+        getRefreshTimeInMs(zoom?: number | undefined): number;
         getTrajectoryInfos(id: RealtimeTrainId): Promise<{
-            stopSequence: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
-            fullTrajectory: WebSocketAPIMessageEventData<RealtimeFullTrajectory> | WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]>;
+            fullTrajectory: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<RealtimeFullTrajectory>;
+            stopSequence: WebSocketAPIMessageEventData<import("../../types").RealtimeStopSequence[]> | WebSocketAPIMessageEventData<RealtimeFullTrajectory>;
         }>;
-        purgeOutOfDateTrajectories(): void;
-        purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
-        addTrajectory(trajectory: RealtimeTrajectory): void;
-        removeTrajectory(trajectoryOrId: RealtimeTrajectory | RealtimeTrainId): void;
-        onZoomEnd(): void;
+        getVehicle(filterFc: import("../../common/typedefs").FilterFunction): RealtimeTrajectory[];
+        highlightVehicle(id: RealtimeTrainId): void;
+        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrainId>): void;
         onDocumentVisibilityChange(): void;
         onTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrajectory>): void;
-        onDeleteTrajectoryMessage(data: WebSocketAPIMessageEventData<RealtimeTrainId>): void;
-        highlightVehicle(id: RealtimeTrainId): 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[]): {
-        options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions;
         olEventsKeys: import("ol/events").EventsKey[];
+        options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions;
+        attachToMap(map: Map): void;
+        detachFromMap(): void;
+        flat(): any[];
+        onChildrenChange(oldValue: Layer[]): void;
+        setMapInternal: ((map: Map) => void) & ((map: import("ol/Map").default | null) => void);
         children: Layer<Source, import("ol/renderer/Layer").default<any>>[];
         get copyrights(): string;
         set copyrights(newCopyrights: string | string[]);
@@ -106,17 +107,10 @@ declare const RealtimeLayer_base: {
         olLayer: Layer;
         parent: Layer<Source, import("ol/renderer/Layer").default<any>>;
         visible: boolean;
-        setMapInternal: ((map: Map) => void) & ((map: import("ol/Map").default | null) => void);
-        onChildrenChange(oldValue: Layer[]): 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>;
+        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         getSource: () => Source | null;
         getRenderSource: () => Source | null;
         getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<Array<import("ol/Feature").FeatureLike>>;
@@ -174,9 +168,11 @@ declare const RealtimeLayer_base: {
         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;
     };
 } & typeof Layer;
@@ -214,42 +210,46 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      *
      */
     constructor(options: RealtimeLayerOptions);
-    /**
-     * @private
-     */
-    createRenderer(): RealtimeLayerRenderer;
     /** @private */
     attachToMap(map: Map): void;
     /**
-     * Destroy the container of the tracker.
+     * Create a copy of the RealtimeLayer.
+     * @param {Object} newOptions Options to override
+     * @return {RealtimeLayer} A RealtimeLayer
+     */
+    clone(newOptions: RealtimeLayerOptions): RealtimeLayer;
+    /**
      * @private
      */
-    detachFromMap(): void;
+    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
      */
-    renderTrajectories(noInterpolate: boolean): void;
     /**
-     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
+     * Destroy the container of the tracker.
      * @private
-     * @override
      */
-    renderTrajectoriesInternal(viewState: ViewState, noInterpolate: boolean): boolean;
+    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.
      *
      * @private
      * @override
      */
-    onMoveEnd(evt: MapEvent | ObjectEvent): void;
+    /**
+     * Highlight the trajectory of journey.
+     * @private
+     */
+    highlightTrajectory(id: RealtimeTrainId): Promise<Feature[] | undefined>;
     /**
      * Function called on moveend event only when the zoom has changed.
      *
@@ -257,31 +257,27 @@ declare class RealtimeLayer extends RealtimeLayer_base {
      * @private
      * @override
      */
+    onMoveEnd(evt: MapEvent | ObjectEvent): void;
     onZoomEnd(): void;
-    highlight(feature: Feature): void;
-    select(feature: Feature): void;
     /**
      * Remove the trajectory form the list if necessary.
      *
      * @private
      */
     purgeTrajectory(trajectory: RealtimeTrajectory, extent: [number, number, number, number], zoom: number): boolean;
+    renderTrajectories(noInterpolate: boolean): void;
     /**
-     * Send the current bbox to the websocket
-     *
+     * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
      * @private
+     * @override
      */
-    setBbox(extent?: [number, number, number, number], zoom?: number): void;
+    renderTrajectoriesInternal(viewState: ViewState, noInterpolate: boolean): boolean;
+    select(feature: Feature): void;
     /**
-     * Highlight the trajectory of journey.
+     * Send the current bbox to the websocket
+     *
      * @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;
+    setBbox(extent?: [number, number, number, number], zoom?: number): void;
 }
 export default RealtimeLayer;