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

package/ol/layers/RealtimeLayer.d.ts

@@ -1,141 +1,136 @@
-import GeoJSON from 'ol/format/GeoJSON';
-import Source from 'ol/source/Source';
-import Feature, { FeatureLike } from 'ol/Feature';
 import { Map, MapEvent } from 'ol';
-import { ObjectEvent } from 'ol/Object';
+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 { RealtimeLayerMixinOptions } from '../../common/mixins/RealtimeLayerMixin';
-import { RealtimeFullTrajectory, RealtimeTrainId, ViewState } from '../../types';
-import { RealtimeTrajectory } from '../../api/typedefs';
+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 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;
+        api: import("..").RealtimeAPI;
+        bboxParameters?: Record<string, boolean | boolean[] | number | number[] | string | string[]>;
+        canvas?: import("../../types").AnyCanvas;
+        debounceRenderTrajectories: (viewState: ViewState, noInterpolate?: boolean) => void;
         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;
+        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;
-        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;
+        live?: boolean;
+        minZoomInterpolation: number;
+        mode: import("../../types").RealtimeMode;
+        mots?: import("../../types").RealtimeMot[];
         motsByZoom: import("../../types").RealtimeMot[][];
-        generalizationLevel?: import("../../types").RealtimeGeneralizationLevel | undefined;
-        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<typeof Feature>;
-        requestId?: number | undefined;
-        updateTimeInterval?: number | undefined;
-        updateTimeDelay?: number | undefined;
+        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;
-        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;
+        addTrajectory(trajectory: RealtimeTrajectory): void;
+        attachToMap(map: import("../../types").AnyMap): void;
         defineProperties(options: RealtimeLayerMixinOptions): void;
-        attachToMap(map: any): 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;
-        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[];
+        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[]);
         disabled: boolean;
         readonly group: string;
-        readonly hitTolerance: boolean;
+        readonly hitTolerance: number;
         readonly key: string;
         readonly map: Map;
         readonly name: string;
-        olLayer: Layer<Source, import("ol/renderer/Layer").default<any>>;
+        olLayer: Layer;
         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>;
+        render: (frameState: import("ol/Map").FrameState | null, target: HTMLElement) => HTMLElement | null;
         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[];
+        getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<Array<import("ol/Feature").FeatureLike>>;
+        getData: (pixel: import("ol/pixel").Pixel) => Uint8ClampedArray | Uint8Array | Float32Array | DataView | null;
+        isVisible: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => boolean;
+        getAttributions: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => Array<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;
+        getMapInternal: () => import("ol/Map").default | null;
+        setMap: (map: import("ol/Map").default | null) => void;
         setSource: (source: Source | null) => void;
         getRenderer: () => import("ol/renderer/Layer").default<any> | null;
         hasRenderer: () => boolean;
-        getBackground: () => false | import("ol/layer/Base").BackgroundColor;
+        getBackground: () => import("ol/layer/Base").BackgroundColor | false;
         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[];
+        getLayersArray: (array?: import("ol/layer/Layer").default<import("ol/source/Source").default, import("ol/renderer/Layer").default<any>>[] | undefined) => Array<import("ol/layer/Layer").default>;
+        getLayerStatesArray: (states?: import("ol/layer/Layer").State[] | undefined) => Array<import("ol/layer/Layer").State>;
         getExtent: () => import("ol/extent").Extent | undefined;
         getMaxResolution: () => number;
         getMinResolution: () => number;
@@ -155,7 +150,7 @@ declare const RealtimeLayer_base: {
         setVisible: (visible: boolean) => void;
         setZIndex: (zindex: number) => void;
         get: (key: string) => any;
-        getKeys: () => string[];
+        getKeys: () => Array<string>;
         getProperties: () => {
             [x: string]: any;
         };
@@ -173,14 +168,16 @@ declare const RealtimeLayer_base: {
         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;
+        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;
 /**
- * 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';
@@ -202,52 +199,57 @@ declare const RealtimeLayer_base: {
 declare class RealtimeLayer extends RealtimeLayer_base {
     /** @private */
     allowRenderWhenAnimating?: boolean;
+    vectorLayer: VectorLayer<Feature>;
     /**
      * 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.url="wss://api.geops.io/tracker-ws/v1/"] The geOps Realtime API url.
      *
      */
     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.
      *
@@ -255,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;