mobility-toolbox-js 2.0.0 → 2.1.0

package/ol/layers/MapGlLayer.js

@@ -0,0 +1,218 @@
+/* eslint-disable max-classes-per-file */
+import { toLonLat } from 'ol/proj';
+import OlLayer from 'ol/layer/Layer';
+import Source from 'ol/source/Source';
+import GeoJSON from 'ol/format/GeoJSON';
+import BaseEvent from 'ol/events/Event';
+import { getUrlWithParams, getMapboxMapCopyrights } from '../../common/utils';
+import Layer from './Layer';
+/**
+ * Common class for Mapbox and Maplibre and potential other fork from Mapbox.
+ * It's used to share code between Mapbox and Maplibre layers without importing both libs.
+ */
+class MapGlLayer extends Layer {
+    constructor(options) {
+        super(options);
+        this.olLayer = new OlLayer({
+            source: new Source({}),
+            render: this.getOlLayerRender(),
+        });
+        /**
+         * Url of the mapbox style.
+         * @type {string}
+         * @private
+         */
+        this.styleUrl = options.url;
+        /**
+         * Api key for the url of the mapbox style.
+         * If set to false, the apiKey is not required.
+         * @type {string}
+         * @private
+         */
+        this.apiKey = options.apiKey;
+        /**
+         * Name of the apiKey to set in the url request.
+         * Default is 'key'.
+         * @type {string}
+         * @private
+         */
+        this.apiKeyName = options.apiKeyName || 'key';
+        /** @ignore */
+        this.updateAttribution = this.updateAttribution.bind(this);
+    }
+    /**
+     * Initialize the layer and listen to feature clicks.
+     * @param {ol/Map~Map} map
+     */
+    attachToMap(map) {
+        super.attachToMap(map);
+        if (!this.map) {
+            return;
+        }
+        /**
+         * The feature format.
+         * @type {ol/format/GeoJSON}
+         */
+        this.format = new GeoJSON({
+            featureProjection: this.map.getView().getProjection(),
+        });
+        this.loadMbMap();
+    }
+    /**
+     * Terminate what was initialized in init function. Remove layer, events...
+     */
+    detachFromMap() {
+        if (this.mbMap) {
+            this.mbMap.off('idle', this.updateAttribution);
+            // Some asynchrone repaints are triggered even if the mbMap has been removed,
+            // to avoid display of errors we set an empty function.
+            this.mbMap.triggerRepaint = () => { };
+            this.mbMap.remove();
+            this.mbMap = undefined;
+        }
+        this.loaded = false;
+        super.detachFromMap();
+    }
+    /**
+     * Create the mapbox map.
+     * @private
+     */
+    loadMbMap() {
+        var _a, _b, _c;
+        this.olListenersKeys.push(
+        // @ts-ignore
+        (_a = this.map) === null || _a === void 0 ? void 0 : _a.on('change:target', () => {
+            this.loadMbMap();
+        }));
+        if (!((_b = this.map) === null || _b === void 0 ? void 0 : _b.getTargetElement())) {
+            return;
+        }
+        if (!this.visible) {
+            // On next change of visibility we load the map
+            this.olListenersKeys.push(
+            // @ts-ignore
+            this.once('change:visible', () => {
+                this.loadMbMap();
+            }));
+            return;
+        }
+        const container = document.createElement('div');
+        container.style.position = 'absolute';
+        container.style.width = '100%';
+        container.style.height = '100%';
+        if (!this.styleUrl) {
+            // eslint-disable-next-line no-console
+            console.error(`No styleUrl defined for mapbox layer: ${this.styleUrl}`);
+            return;
+        }
+        if (!this.apiKey && !((_c = this.styleUrl) === null || _c === void 0 ? void 0 : _c.includes(this.apiKeyName))) {
+            // eslint-disable-next-line no-console
+            console.error(`No apiKey defined for mapbox layer with style url to ${this.styleUrl}`);
+        }
+        const Map = this.getMapboxMapClass();
+        /**
+         * A mapbox map
+         * @type {mapboxgl.Map}
+         */
+        this.mbMap = new Map(Object.assign({ style: getUrlWithParams(this.styleUrl, {
+                [this.apiKeyName]: this.apiKey,
+            }).toString(), container, interactive: false, trackResize: false, attributionControl: false }, (this.options.mapOptions || {})));
+        this.mbMap.once('load', () => {
+            /**
+             * Is the map loaded.
+             * @type {boolean}
+             */
+            this.loaded = true;
+            this.dispatchEvent(new BaseEvent('load'));
+        });
+        this.mbMap.on('idle', this.updateAttribution);
+    }
+    /**
+     * Update attributions of the source.
+     * @private
+     */
+    updateAttribution(evt) {
+        var _a, _b, _c;
+        const newAttributions = getMapboxMapCopyrights(evt.target) || [];
+        if (((_a = this.copyrights) === null || _a === void 0 ? void 0 : _a.toString()) !== newAttributions.toString()) {
+            this.copyrights = newAttributions;
+            // @ts-ignore
+            (_c = (_b = this.olLayer) === null || _b === void 0 ? void 0 : _b.getSource()) === null || _c === void 0 ? void 0 : _c.setAttributions(newAttributions);
+        }
+    }
+    /**
+     * Request feature information for a given coordinate.
+     * @param {ol/coordinate~Coordinate} coordinate Coordinate to request the information at.
+     * @param {Object} options A [mapboxgl.Map#queryrenderedfeatures](https://docs.mapbox.com/mapbox-gl-js/api/map/#map#queryrenderedfeatures) options parameter.
+     * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate. The original Mapbox feature is available as a property named 'mapboxFeature'.
+     */
+    getFeatureInfoAtCoordinate(coordinate, options) {
+        // Ignore the getFeatureInfo until the mapbox map is loaded
+        if (!options ||
+            !this.format ||
+            !this.mbMap ||
+            !this.mbMap.isStyleLoaded()) {
+            return Promise.resolve({ coordinate, features: [], layer: this });
+        }
+        const pixel = coordinate &&
+            this.mbMap.project(toLonLat(coordinate));
+        let pixels;
+        if (this.hitTolerance) {
+            const { x, y } = pixel;
+            pixels = [
+                {
+                    x: x - this.hitTolerance,
+                    y: y - this.hitTolerance,
+                },
+                {
+                    x: x + this.hitTolerance,
+                    y: y + this.hitTolerance,
+                },
+            ];
+        }
+        // At this point we get GeoJSON Mapbox feature, we transform it to an OpenLayers
+        // feature to be consistent with other layers.
+        const features = this.mbMap
+            // @ts-ignore
+            .queryRenderedFeatures(pixels || pixel, options)
+            .map((feature) => {
+            const olFeature = this.format.readFeature(feature);
+            if (olFeature) {
+                // We save the original mapbox feature to avoid losing informations
+                // potentially needed for other functionnality like highlighting
+                // (id, layer id, source, sourceLayer ...)
+                olFeature.set('mapboxFeature', feature);
+            }
+            return olFeature;
+        });
+        return Promise.resolve({
+            layer: this,
+            features,
+            coordinate,
+        });
+    }
+    /**
+     * Return the render function function for the ol layer.
+     *
+     */
+    // eslint-disable-next-line class-methods-use-this
+    getOlLayerRender() {
+        // eslint-disable-next-line no-console
+        console.error('This function must be implemented in subclasses');
+        const div = document.createElement('div');
+        return () => div;
+    }
+    /**
+     * Return the Class to instanciate for the mapbox map.
+     *
+     * @return {mapboxgl.Map|maplibregl.Map} map
+     */
+    // eslint-disable-next-line class-methods-use-this
+    getMapboxMapClass() {
+        // eslint-disable-next-line no-console
+        console.error('This function must be implemented in subclasses');
+        // @ts-ignore
+        return null;
+    }
+}
+export default MapGlLayer;

package/ol/layers/MapboxLayer.d.ts

@@ -0,0 +1,50 @@
+import { Map } from 'mapbox-gl';
+import { Coordinate } from 'ol/coordinate';
+import type OlMap from 'ol/Map';
+import { Size } from 'ol/size';
+import MapGlLayer, { MapGlLayerOptions } from './MapGlLayer';
+/**
+ * A class representing Mapboxlayer to display on BasicMap
+ *
+ * @example
+ * import { MapboxLayer } from 'mobility-toolbox-js/ol';
+ *
+ * const layer = new MapboxLayer({
+ *   url: 'https://maps.geops.io/styles/travic_v2/style.json',
+ *   apikey: 'yourApiKey',
+ * });
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {Layer}
+ */
+export default class MapboxLayer extends MapGlLayer {
+    renderState?: {
+        center?: Coordinate;
+        zoom?: number;
+        visible?: boolean;
+        opacity?: number;
+        resolution?: number;
+        rotation?: number;
+        size?: Size;
+    };
+    tabIndex?: number;
+    /**
+     * Initialize the layer and listen to feature clicks.
+     * @param {ol/Map~Map} map
+     */
+    attachToMap(map: OlMap): void;
+    /**
+     * Create the mapbox map.
+     * @private
+     */
+    loadMbMap(): void;
+    getOlLayerRender(): import("ol/layer/Layer").RenderFunction;
+    getMapboxMapClass(): typeof Map;
+    /**
+     * Create a copy of the MapboxLayer.
+     * @param {Object} newOptions Options to override
+     * @return {MapboxLayer} A MapboxLayer
+     */
+    clone(newOptions: MapGlLayerOptions): MapboxLayer;
+}
+//# sourceMappingURL=MapboxLayer.d.ts.map

package/ol/layers/MapboxLayer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapboxLayer.d.ts","sourceRoot":"","sources":["../../../src/ol/layers/MapboxLayer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAChC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,KAAK,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAE/B,OAAO,UAAU,EAAE,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,UAAU;IACjD,WAAW,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,UAAU,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,IAAI,CAAC;KACb,CAAC;IAEF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,WAAW,CAAC,GAAG,EAAE,KAAK;IAsBtB;;;OAGG;IACH,SAAS;IAqDT,gBAAgB;IAKhB,iBAAiB;IAIjB;;;;OAIG;IACH,KAAK,CAAC,UAAU,EAAE,iBAAiB;CAGpC"}