mobility-toolbox-js 2.0.0-beta.1 → 2.0.0

package/ol/layers/TrackerLayer.js

@@ -1,296 +0,0 @@
-import { Layer as OLLayer, Group, Vector as VectorLayer } from 'ol/layer';
-import Source from 'ol/source/Source';
-import { composeCssTransform } from 'ol/transform';
-import { Vector as VectorSource } from 'ol/source';
-import mixin from '../../common/mixins/TrackerLayerMixin';
-
-import Layer from './Layer';
-
-/**
- * Responsible for loading tracker data.
- *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
- * @extends {Layer}
- * @implements {TrackerLayerInterface}
- */
-class TrackerLayer extends mixin(Layer) {
-  /**
-   * Constructor.
-   *
-   * @param {Object} options
-   * @param {boolean} options.useDelayStyle Set the delay style.
-   * @private
-   */
-  constructor(options = {}) {
-    // We use a group to be able to add custom vector layer in extended class.
-    // For example TrajservLayer use a vectorLayer to display the complete trajectory.
-    super({
-      ...options,
-    });
-
-    /** @ignore */
-    this.olLayer =
-      options.olLayer ||
-      new Group({
-        layers: [
-          new VectorLayer({
-            source: new VectorSource({ features: [] }),
-          }),
-          new OLLayer({
-            source: new Source({}),
-            render: (frameState) => {
-              if (!this.tracker || !this.tracker.canvas) {
-                return null;
-              }
-
-              if (!this.container) {
-                this.container = document.createElement('div');
-                this.container.style.position = 'absolute';
-                this.container.style.width = '100%';
-                this.container.style.height = '100%';
-                this.transformContainer = document.createElement('div');
-                this.transformContainer.style.position = 'absolute';
-                this.transformContainer.style.width = '100%';
-                this.transformContainer.style.height = '100%';
-                this.container.appendChild(this.transformContainer);
-                this.tracker.canvas.style.position = 'absolute';
-                this.tracker.canvas.style.top = '0';
-                this.tracker.canvas.style.left = '0';
-                this.tracker.canvas.style.transformOrigin = 'top left';
-                this.transformContainer.appendChild(this.tracker.canvas);
-              }
-
-              if (this.renderedViewState) {
-                const { center, resolution, rotation } = frameState.viewState;
-                const {
-                  center: renderedCenter,
-                  resolution: renderedResolution,
-                  rotation: renderedRotation,
-                } = this.renderedViewState;
-
-                if (renderedResolution / resolution >= 3) {
-                  // Avoid having really big points when zooming fast.
-                  const { canvas } = this.tracker;
-                  const context = canvas.getContext('2d');
-                  context.clearRect(0, 0, canvas.width, canvas.height);
-                } else {
-                  const pixelCenterRendered =
-                    this.map.getPixelFromCoordinate(renderedCenter);
-                  const pixelCenter = this.map.getPixelFromCoordinate(center);
-                  this.transformContainer.style.transform = composeCssTransform(
-                    pixelCenterRendered[0] - pixelCenter[0],
-                    pixelCenterRendered[1] - pixelCenter[1],
-                    renderedResolution / resolution,
-                    renderedResolution / resolution,
-                    rotation - renderedRotation,
-                    0,
-                    0,
-                  );
-                }
-              }
-              return this.container;
-            },
-          }),
-        ],
-      });
-
-    // We store the layer used to highlight the full Trajectory
-    this.vectorLayer = this.olLayer.getLayers().item(0);
-
-    // Options the last render run did happen. If something changes
-    // we have to render again
-    /** @ignore */
-    this.renderState = {
-      center: [0, 0],
-      zoom: null,
-      rotation: 0,
-    };
-  }
-
-  init(map) {
-    super.init(map);
-    if (this.map) {
-      this.olListenersKeys.push(
-        this.map.on('moveend', (evt) => {
-          const view = this.map.getView();
-          if (view.getAnimating() || view.getInteracting()) {
-            return;
-          }
-          const zoom = view.getZoom();
-
-          // Update the interval between render updates
-          if (this.currentZoom !== zoom) {
-            this.onZoomEnd(evt);
-          }
-          this.currentZoom = zoom;
-
-          this.onMoveEnd(evt);
-        }),
-      );
-    }
-  }
-
-  /**
-   * Destroy the container of the tracker.
-   */
-  terminate() {
-    super.terminate();
-    this.container = null;
-  }
-
-  /**
-   * Detect in the canvas if there is data to query at a specific coordinate.
-   * @param {ol/coordinate~Coordinate}  coordinate The coordinate to test
-   * @returns
-   */
-  hasFeatureInfoAtCoordinate(coordinate) {
-    if (this.map && this.tracker && this.tracker.canvas) {
-      const context = this.tracker.canvas.getContext('2d');
-      const pixel = this.map.getPixelFromCoordinate(coordinate);
-      return !!context.getImageData(
-        pixel[0] * this.pixelRatio,
-        pixel[1] * this.pixelRatio,
-        1,
-        1,
-      ).data[3];
-    }
-    return false;
-  }
-
-  /**
-   * 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) {
-    const view = this.map.getView();
-    super.renderTrajectories(
-      {
-        size: this.map.getSize(),
-        center: this.map.getView().getCenter(),
-        extent: view.calculateExtent(),
-        resolution: view.getResolution(),
-        rotation: view.getRotation(),
-        zoom: view.getZoom(),
-        pixelRatio: this.pixelRatio,
-      },
-      noInterpolate,
-    );
-  }
-
-  /**
-   * Launch renderTrajectories. it avoids duplicating code in renderTrajectories methhod.
-   * @private
-   * @override
-   */
-  renderTrajectoriesInternal(viewState, noInterpolate) {
-    let isRendered = false;
-
-    const blockRendering =
-      this.map.getView().getAnimating() || this.map.getView().getInteracting();
-
-    // Don't render the map when the map is animating or interacting.
-    isRendered = blockRendering
-      ? false
-      : super.renderTrajectoriesInternal(viewState, noInterpolate);
-
-    // We update the current render state.
-    if (isRendered) {
-      this.renderedViewState = { ...viewState };
-
-      if (this.transformContainer) {
-        this.transformContainer.style.transform = '';
-      }
-    }
-  }
-
-  /**
-   * Return the delay in ms before the next rendering.
-   */
-  getRefreshTimeInMs() {
-    return super.getRefreshTimeInMs(this.map.getView().getZoom());
-  }
-
-  /**
-   * Returns the vehicle which are at the given coordinates.
-   * Returns null when no vehicle is located at the given coordinates.
-   * @param {ol/coordinate~Coordinate} coordinate
-   * @param {number} nb Number of vehicles to return;
-   * @return {Array<ol/Feature~Feature>} Vehicle feature.
-   * @override
-   */
-  getVehiclesAtCoordinate(coordinate, nb) {
-    const resolution = this.map.getView().getResolution();
-    return super.getVehiclesAtCoordinate(coordinate, resolution, nb);
-  }
-
-  getFeatureInfoAtCoordinate(coordinate, options = {}) {
-    if (!this.hasFeatureInfoAtCoordinate(coordinate)) {
-      return Promise.resolve({ features: [], layer: this, coordinate });
-    }
-    const resolution = this.map.getView().getResolution();
-    return super.getFeatureInfoAtCoordinate(coordinate, {
-      resolution,
-      ...options,
-    });
-  }
-
-  /**
-   * Function called on moveend event.
-   * To be defined in inherited classes
-   *
-   * @param {ol/MapEvent~MapEvent} evt Moveend event.
-   * @private
-   */
-  // eslint-disable-next-line no-unused-vars,class-methods-use-this
-  onMoveEnd(evt) {}
-
-  /**
-   * Function called on moveend event only when the zoom has changed.
-   *
-   * @param {ol/MapEvent~MapEvent} evt Moveend event.
-   * @private
-   * @override
-   */
-  // eslint-disable-next-line no-unused-vars
-  onZoomEnd(evt) {
-    super.onZoomEnd(evt);
-  }
-
-  /**
-   * Update the cursor style when hovering a vehicle.
-   *
-   * @private
-   * @override
-   */
-  onFeatureHover(features, layer, coordinate) {
-    super.onFeatureHover(features, layer, coordinate);
-    this.map.getTargetElement().style.cursor = features.length
-      ? 'pointer'
-      : 'auto';
-  }
-
-  /**
-   * Display the complete trajectory of the vehicle.
-   *
-   * @private
-   * @override
-   */
-  onFeatureClick(features, layer, coordinate) {
-    super.onFeatureClick(features, layer, coordinate);
-    if (!features.length && this.vectorLayer) {
-      this.vectorLayer.getSource().clear();
-    }
-  }
-
-  /**
-   * Create a copy of the TrackerLayer.
-   * @param {Object} newOptions Options to override
-   * @return {TrackerLayer} A TrackerLayer
-   */
-  clone(newOptions) {
-    return new TrackerLayer({ ...this.options, ...newOptions });
-  }
-}
-
-export default TrackerLayer;

package/ol/layers/TrackerLayer.test.js

@@ -1,70 +0,0 @@
-import Map from 'ol/Map';
-import View from 'ol/View';
-import TrackerLayer from './TrackerLayer';
-
-let layer;
-let onClick;
-
-describe('TrackerLayer', () => {
-  beforeEach(() => {
-    onClick = jest.fn();
-    layer = new TrackerLayer({
-      onClick,
-    });
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(TrackerLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-    layer.init(
-      new Map({
-        view: new View({
-          center: [831634, 5933959],
-          zoom: 9,
-        }),
-      }),
-    );
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-
-  test('#onClick', () => {
-    const f = () => {};
-    layer.onClick(f);
-    expect(layer.clickCallbacks[1]).toBe(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-    layer.onClick(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test('#unClick', () => {
-    const foo = () => {};
-    const bar = () => {};
-    layer.onClick(foo);
-    layer.onClick(bar);
-    expect(layer.clickCallbacks[1]).toBe(foo);
-    expect(layer.clickCallbacks[2]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(3);
-    layer.unClick(foo);
-    expect(layer.clickCallbacks[1]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  describe('#terminate', () => {
-    test('should set container to null', () => {
-      layer.container = 'foo';
-      layer.terminate();
-      expect(layer.container).toBe(null);
-    });
-  });
-
-  test('should clone', () => {
-    const clone = layer.clone({ name: 'clone' });
-    expect(clone).not.toBe(layer);
-    expect(clone.name).toBe('clone');
-    expect(clone).toBeInstanceOf(TrackerLayer);
-  });
-});

package/ol/layers/TrajservLayer.js

@@ -1,190 +0,0 @@
-import Feature from 'ol/Feature';
-import { fromLonLat } from 'ol/proj';
-import { buffer, getWidth } from 'ol/extent';
-import { MultiPoint, LineString } from 'ol/geom';
-import { Style, Fill, Stroke, Circle } from 'ol/style';
-import { unByKey } from 'ol/Observable';
-import TrackerLayer from './TrackerLayer';
-
-import mixin from '../../common/mixins/TrajservLayerMixin';
-
-/**
- * Responsible for loading and display data from a Trajserv service.
- *
- * @example
- * import { TrajservLayer } from 'mobility-toolbox-js/mapbox';
- *
- * const layer = new TrajservLayer({
- *   url: 'https://api.geops.io/tracker/v1',
- *   apiKey: [yourApiKey],
- * });
- *
- *
- * @see <a href="/api/class/src/api/trajserv/TrajservAPI%20js~TrajservAPI%20html">TrajservAPI</a>
- * @see <a href="/example/ol-tracker">OL tracker example</a>
- *
- * @extends {TrackerLayer}
- * @implements {TrajservLayerInterface}
- * @deprecated Use {@link TralisLayer} instead.
- */
-class TrajservLayer extends mixin(TrackerLayer) {
-  /**
-   * Start the layer.
-   * @override
-   */
-  start() {
-    if (!this.map) {
-      return;
-    }
-    super.start();
-    /**
-     * Array of ol events key, returned by on() or once().
-     * @type {Array<ol/events~EventsKey>}
-     * @ignore
-     */
-    this.olEventsKeys = [
-      this.map.on('movestart', () => {
-        this.abortFetchTrajectories();
-      }),
-      this.map.on('moveend', this.onMoveEnd.bind(this)),
-    ];
-  }
-
-  stop() {
-    unByKey(this.olEventsKeys);
-    super.stop();
-  }
-
-  /**
-   * Callback on 'moveend' event.
-   * @private
-   */
-  onMoveEnd() {
-    const z = this.map.getView().getZoom();
-
-    if (z !== this.currentZoom) {
-      /**
-       * Current value of the zoom.
-       * @type {number}
-       * @ignore
-       */
-      this.currentZoom = z;
-
-      // This will restart the timeouts.
-      // TODO maybe find a calculation a bit less approximative.
-      /** @ignore */
-      this.requestIntervalSeconds = 200 / z || 1000;
-    }
-
-    this.abortFetchTrajectories();
-    if (
-      !this.map.getView().getAnimating() &&
-      !this.map.getView().getInteracting()
-    ) {
-      this.updateTrajectories();
-    }
-
-    if (this.selectedVehicleId && this.journeyId) {
-      this.highlightTrajectory();
-    }
-  }
-
-  /**
-   * Draw the trajectory as a line with points for each stop.
-   * @param {Array} stationsCoords Array of station coordinates in epsg:4326.
-   * @param {Array<ol/coordinate~Coordinate>} lineCoords A list of coordinates.
-   * @param {string} color The color of the line.
-   * @private
-   */
-  drawFullTrajectory(stationsCoords, lineCoords, color) {
-    const vectorSource = this.vectorLayer.getSource();
-    vectorSource.clear();
-
-    // Add station points
-    if (stationsCoords) {
-      const geometry = new MultiPoint(
-        stationsCoords.map((coords) => fromLonLat(coords)),
-      );
-      const aboveStationsFeature = new Feature(geometry);
-      aboveStationsFeature.setStyle(
-        new Style({
-          zIndex: 1,
-          image: new Circle({
-            radius: 5,
-            fill: new Fill({
-              color: '#000000',
-            }),
-          }),
-        }),
-      );
-      const belowStationsFeature = new Feature(geometry);
-      belowStationsFeature.setStyle(
-        new Style({
-          zIndex: 4,
-          image: new Circle({
-            radius: 4,
-            fill: new Fill({
-              color,
-            }),
-          }),
-        }),
-      );
-      vectorSource.addFeatures([aboveStationsFeature, belowStationsFeature]);
-    }
-
-    // Add line.
-    if (lineCoords) {
-      const lineFeat = new Feature({
-        geometry: new LineString(lineCoords),
-      });
-      lineFeat.setStyle([
-        new Style({
-          zIndex: 2,
-          stroke: new Stroke({
-            color: '#000000',
-            width: 6,
-          }),
-        }),
-        new Style({
-          zIndex: 3,
-          stroke: new Stroke({
-            color,
-            width: 4,
-          }),
-        }),
-      ]);
-      vectorSource.addFeature(lineFeat);
-    }
-  }
-
-  /**
-   * @override
-   * * Returns the URL parameters.
-   * @param {Object} extraParams Extra parameters
-   * @return {Object}
-   * @private
-   */
-  getParams(extraParams = {}) {
-    const ext = this.map.getView().calculateExtent();
-    const bbox = buffer(ext, getWidth(ext) / 10).join(',');
-    const zoom = this.map.getView().getZoom();
-
-    return super.getParams({
-      ...extraParams,
-      bbox,
-      s: zoom < 10 ? 1 : 0,
-      z: zoom,
-    });
-  }
-
-  /**
-   * Create a copy of the TrajservLayer.
-   * @param {Object} newOptions Options to override
-   * @return {TrajservLayer} A TrajservLayer
-   */
-  clone(newOptions) {
-    return new TrajservLayer({ ...this.options, ...newOptions });
-  }
-}
-
-export default TrajservLayer;

package/ol/layers/TrajservLayer.test.js

@@ -1,113 +0,0 @@
-import fetch from 'jest-fetch-mock';
-import Map from 'ol/Map';
-import View from 'ol/View';
-import TrajservLayer from './TrajservLayer';
-
-let layer;
-let onClick;
-let olMap;
-
-describe('TrajservLayer', () => {
-  beforeEach(() => {
-    global.fetch = fetch;
-    fetch.resetMocks();
-
-    onClick = jest.fn();
-    layer = new TrajservLayer({
-      apiKey: 'apiKey',
-      onClick,
-    });
-
-    olMap = new Map({
-      view: new View({
-        center: [831634, 5933959],
-        zoom: 9,
-      }),
-    });
-  });
-
-  test('should be instanced.', () => {
-    expect(layer).toBeInstanceOf(TrajservLayer);
-    expect(layer.clickCallbacks[0]).toBe(onClick);
-  });
-
-  test('should called terminate on initalization.', () => {
-    const spy = jest.spyOn(layer, 'terminate');
-
-    fetch.mockResponseOnce(JSON.stringify(global.fetchTrajectoriesResponse));
-
-    layer.init(olMap);
-    expect(spy).toHaveBeenCalledTimes(1);
-  });
-
-  test('#onClick', () => {
-    const f = () => {};
-    layer.onClick(f);
-    expect(layer.clickCallbacks[1]).toBe(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-    layer.onClick(f);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test('#unClick', () => {
-    const foo = () => {};
-    const bar = () => {};
-    layer.onClick(foo);
-    layer.onClick(bar);
-    expect(layer.clickCallbacks[1]).toBe(foo);
-    expect(layer.clickCallbacks[2]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(3);
-    layer.unClick(foo);
-    expect(layer.clickCallbacks[1]).toBe(bar);
-    expect(layer.clickCallbacks.length).toBe(2);
-  });
-
-  test("map events should be called if zoom doesn't change", () => {
-    const spy2 = jest.spyOn(layer, 'onMoveEnd');
-
-    // Mock response for the following calls
-    fetch.mockResponse(JSON.stringify(global.fetchTrajectoriesResponse));
-
-    // init uses mockResponse
-    layer.init(olMap);
-
-    // Start uses mockResponse
-    layer.start();
-
-    // dispatchEvent uses mockResponse
-    const evt2 = { type: 'moveend', olMap };
-    olMap.dispatchEvent(evt2);
-    expect(spy2).toHaveBeenCalledTimes(2);
-    olMap.dispatchEvent(evt2);
-    expect(spy2).toHaveBeenCalledTimes(4);
-  });
-
-  test('should create a default api with default url.', () => {
-    expect(layer).toBeInstanceOf(TrajservLayer);
-    expect(layer.api.url).toBe('https://api.geops.io/tracker/v1');
-    expect(layer.api.apiKey).toBe('apiKey');
-  });
-
-  test('should create an api with custom url and apiKey.', () => {
-    const layr = new TrajservLayer({
-      url: 'https:foo.ch',
-      apiKey: 'bar',
-    });
-    expect(layr).toBeInstanceOf(TrajservLayer);
-    expect(layr.api.url).toBe('https:foo.ch');
-    expect(layr.api.apiKey).toBe('bar');
-  });
-
-  test('should clone', () => {
-    const layr = new TrajservLayer({
-      name: 'test',
-      url: 'https:foo.ch',
-      apiKey: 'bar',
-    });
-    const clone = layr.clone({ name: 'clone' });
-    expect(layr.name).toBe('test');
-    expect(clone).not.toBe(layr);
-    expect(clone.name).toBe('clone');
-    expect(clone).toBeInstanceOf(TrajservLayer);
-  });
-});