mobility-toolbox-js 2.0.0-beta.30 → 2.0.0-beta.34

package/mapbox/layers/Layer.js

@@ -1,56 +1,139 @@
-import { unByKey } from "ol/Observable";
-import { transformExtent } from "ol/proj";
-import LayerCommon from "../../common/layers/Layer";
-import userInteractionsMixin from "../../common/mixins/UserInteractionsLayerMixin";
-class Layer extends userInteractionsMixin(LayerCommon) {
-  attachToMap(map) {
-    super.attachToMap(map);
-    if (!this.map) {
-      return;
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
     }
-    if (this.userInteractions) {
-      this.toggleVisibleListeners();
-      this.onChangeVisibleKey = this.on("change:visible", this.toggleVisibleListeners);
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Observable_1 = require("ol/Observable");
+var proj_1 = require("ol/proj");
+var Layer_1 = require("../../common/layers/Layer");
+var UserInteractionsLayerMixin_1 = require("../../common/mixins/UserInteractionsLayerMixin");
+/**
+ * A class representing a layer to display on an OpenLayers map.
+ *
+ * @example
+ * import { Layer } from 'mobility-toolbox-js/ol';
+ *
+ * const layer = new Layer({
+ *   olLayer: ...,
+ * });
+ *
+ * @see <a href="/example/ol-map">Map example</a>
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {Layer}
+ */
+var Layer = /** @class */ (function (_super) {
+    __extends(Layer, _super);
+    function Layer() {
+        return _super !== null && _super.apply(this, arguments) || this;
     }
-  }
-  detachFromMap() {
-    if (this.map) {
-      this.deactivateUserInteractions();
-      unByKey(this.onChangeVisibleKey);
-    }
-    super.detachFromMap();
-  }
-  activateUserInteractions() {
-    this.deactivateUserInteractions();
-    if (this.map && this.userInteractions && this.userClickInteractions && this.userClickCallbacks.length) {
-      this.map.on("click", this.onUserClickCallback);
-    }
-    if (this.map && this.userInteractions && this.userHoverInteractions && this.userHoverCallbacks.length) {
-      this.map.on("mousemove", this.onUserMoveCallback);
-    }
-  }
-  deactivateUserInteractions() {
-    if (this.map) {
-      this.map.off("mousemove", this.onUserMoveCallback);
-      this.map.off("click", this.onUserClickCallback);
-    }
-  }
-  toggleVisibleListeners() {
-    if (this.visible) {
-      this.activateUserInteractions();
-    } else {
-      this.deactivateUserInteractions();
-    }
-  }
-  getMercatorExtent() {
-    const bounds = this.map.getBounds().toArray();
-    return transformExtent([...bounds[0], ...bounds[1]], "EPSG:4326", "EPSG:3857");
-  }
-  getOlZoom() {
-    return this.map.getZoom() + 1;
-  }
-  clone(newOptions) {
-    return new Layer({ ...this.options, ...newOptions });
-  }
-}
-export default Layer;
+    /**
+     * Initialize the layer and listen to user events.
+     * @param {ol/Map~Map} map
+     */
+    Layer.prototype.attachToMap = function (map) {
+        _super.prototype.attachToMap.call(this, map);
+        if (!this.map) {
+            return;
+        }
+        if (this.userInteractions) {
+            this.toggleVisibleListeners();
+            this.onChangeVisibleKey = this.on('change:visible', this.toggleVisibleListeners);
+        }
+    };
+    Layer.prototype.detachFromMap = function () {
+        if (this.map) {
+            this.deactivateUserInteractions();
+            (0, Observable_1.unByKey)(this.onChangeVisibleKey);
+        }
+        _super.prototype.detachFromMap.call(this);
+    };
+    Layer.prototype.activateUserInteractions = function () {
+        this.deactivateUserInteractions();
+        if (this.map &&
+            this.userInteractions &&
+            this.userClickInteractions &&
+            this.userClickCallbacks.length) {
+            this.map.on('click', this.onUserClickCallback);
+        }
+        if (this.map &&
+            this.userInteractions &&
+            this.userHoverInteractions &&
+            this.userHoverCallbacks.length) {
+            this.map.on('mousemove', this.onUserMoveCallback);
+        }
+    };
+    Layer.prototype.deactivateUserInteractions = function () {
+        if (this.map) {
+            this.map.off('mousemove', this.onUserMoveCallback);
+            this.map.off('click', this.onUserClickCallback);
+        }
+    };
+    /**
+     * Toggle listeners needed when a layer is avisible or not.
+     * @private
+     */
+    Layer.prototype.toggleVisibleListeners = function () {
+        if (this.visible) {
+            this.activateUserInteractions();
+        }
+        else {
+            this.deactivateUserInteractions();
+        }
+    };
+    /**
+     * Returns the current extent in mercator coordinates.
+     */
+    Layer.prototype.getMercatorExtent = function () {
+        var bounds = this.map.getBounds().toArray();
+        return (0, proj_1.transformExtent)(__spreadArray(__spreadArray([], bounds[0], true), bounds[1], true), 'EPSG:4326', 'EPSG:3857');
+    };
+    /**
+     * Returns the equivalent zoom in Openlayers.
+     */
+    Layer.prototype.getOlZoom = function () {
+        return this.map.getZoom() + 1;
+    };
+    /**
+     * Create a copy of the Layer.
+     * @param {Object} newOptions Options to override
+     * @return {Layer} A Layer
+     */
+    Layer.prototype.clone = function (newOptions) {
+        return new Layer(__assign(__assign({}, this.options), newOptions));
+    };
+    return Layer;
+}((0, UserInteractionsLayerMixin_1.default)(Layer_1.default)));
+exports.default = Layer;

package/mapbox/layers/RealtimeLayer.d.ts

@@ -0,0 +1,118 @@
+export default RealtimeLayer;
+/**
+ * Responsible for loading and display data from a Realtime service.
+ *
+ * @example
+ * import { RealtimeLayer } from 'mobility-toolbox-js/mapbox';
+ *
+ * const layer = new RealtimeLayer({
+ *   url: [yourUrl],
+ *   apiKey: [yourApiKey],
+ * });
+ *
+ *
+ * @see <a href="/api/class/src/api/RealtimeAPI%20js~RealtimeAPI%20html">RealtimeAPI</a>
+ *
+ * @extends {Layer}
+ * @implements {RealtimeLayerInterface}
+ */
+declare class RealtimeLayer extends Layer implements RealtimeLayerInterface {
+    constructor(options?: {});
+    onLoad(): void;
+    /**
+     * Callback on 'move' event.
+     *
+     * @private
+     */
+    private onMove;
+    /**
+     * Send the new BBOX to the websocket.
+     *
+     * @private
+     * @override
+     */
+    private override onMoveEnd;
+    /** @ignore */
+    onZoomEnd: any;
+    onVisibilityChange(): void;
+    /**
+     * Initialize the layer.
+     *
+     * @param {mapboxgl.Map} map A [mapbox Map](https://docs.mapbox.com/mapbox-gl-js/api/map/).
+     * @param {string} beforeId Layer's id before which we want to add the new layer.
+     * @override
+     */
+    override attachToMap(map: mapboxgl.Map, beforeId: string): void;
+    source: {
+        type: string;
+        canvas: any;
+        coordinates: any[][];
+        animate: boolean;
+        attribution: any;
+    };
+    beforeId: string;
+    layer: {
+        id: any;
+        type: string;
+        source: any;
+        layout: {
+            visibility: string;
+        };
+        paint: {
+            'raster-opacity': number;
+            'raster-fade-duration': number;
+            'raster-resampling': string;
+        };
+    };
+    listeners: any[];
+    /**
+     * Start updating vehicles position.
+     *
+     * @listens {mapboxgl.map.event:zoomend} Listen to zoom end event.
+     * @listens {mapboxgl.map.event:mousemove} Listen to mousemove end.
+     * @override
+     */
+    override start(): void;
+    /**
+     * Stop updating vehicles position, and unlisten events.
+     *
+     * @override
+     */
+    override stop(): void;
+    /**
+     * Function triggered when the user moves the cursor over the map.
+     * @override
+     */
+    override onUserMoveCallback(evt: any): 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
+     */
+    renderTrajectories(noInterpolate: boolean): void;
+    /**
+     * Return the delay in ms before the next rendering.
+     */
+    getRefreshTimeInMs(): any;
+    getFeatureInfoAtCoordinate(coordinate: any, options?: {}): any;
+    /**
+     * Remove the trajectory form the list if necessary.
+     *
+     * @private
+     */
+    private purgeTrajectory;
+    /**
+     * Send the current bbox to the websocket
+     */
+    setBbox(extent: any, zoom: any): void;
+    renderTrajectoriesInternal(viewState: any, noInterpolate: any): any;
+    /**
+     * Update the cursor style when hovering a vehicle.
+     *
+     * @private
+     * @override
+     */
+    private override onFeatureHover;
+}
+import Layer from "./Layer";
+//# sourceMappingURL=RealtimeLayer.d.ts.map

package/mapbox/layers/RealtimeLayer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RealtimeLayer.d.ts","sourceRoot":"","sources":["../../../src/mapbox/layers/RealtimeLayer.js"],"names":[],"mappings":";AASA;;;;;;;;;;;;;;;;GAgBG;AACH,qDAFgB,sBAAsB;IAGpC,0BAmBC;IAuGD,eAOC;IA0HD;;;;OAIG;IACH,eAEC;IAcD;;;;;OAKG;IACH,2BAMC;IA9QC,cAAc;IACd,eAA0C;IAoM5C,2BAYC;IA1MD;;;;;;OAMG;IACH,kDAHW,MAAM,QA8ChB;IA/BC;;;;;;MAOC;IAED,iBAAwB;IACxB;;;;;;;;;;;;MAYC;IAQD,iBAAqE;IAuBvE;;;;;;OAMG;IACH,uBAMC;IAED;;;;OAIG;IACH,sBAOC;IAWD;;;OAGG;IACH,4CAKC;IAED;;;;OAIG;IACH,kCAHW,OAAO,QAkDjB;IAED;;OAEG;IACH,0BAEC;IAED,+DAMC;IAgBD;;;;OAIG;IACH,wBAMC;IAED;;OAEG;IACH,sCAQC;IAWD,oEAUC;IAgBD;;;;;OAKG;IACH,gCAKC;CACF"}