mobility-toolbox-js 3.0.0-beta.10 → 3.0.0-beta.11

package/ol/layers/MapGlLayer.d.ts

@@ -1,144 +0,0 @@
-import Source from 'ol/source/Source';
-import OlMap from 'ol/Map';
-import BaseEvent from 'ol/events/Event';
-import Layer from 'ol/layer/Layer';
-import { AnyMapGlMap } from '../../types';
-import { MobilityLayerOptions } from '../mixins/MobilityLayerMixin';
-export type MapGlLayerOptions = MobilityLayerOptions & {
-    apiKey?: string;
-    apiKeyName?: string;
-    style?: string | maplibregl.StyleSpecification;
-    url?: string;
-    mapOptions?: maplibregl.MapOptions;
-    queryRenderedFeaturesOptions?: maplibregl.QueryRenderedFeaturesOptions;
-};
-declare const MapGlLayer_base: {
-    new (...args: any[]): {
-        options?: import("../mixins/PropertiesLayerMixin").PropertiesLayerMixinOptions | undefined;
-        olListenersKeys: import("ol/events").EventsKey[];
-        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 key: string;
-        readonly map: OlMap;
-        readonly name: string;
-        olLayer: Layer<Source, import("ol/renderer/Layer").default<any>>;
-        parent: Layer<Source, import("ol/renderer/Layer").default<any>>;
-        visible: boolean;
-        setMapInternal: ((map: OlMap) => void) & ((map: OlMap | null) => void);
-        onChildrenChange(oldValue: Layer<Source, import("ol/renderer/Layer").default<any>>[]): void;
-        attachToMap(map: OlMap): 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>;
-        getSource: () => Source | null;
-        getRenderSource: () => Source | null;
-        getFeatures: (pixel: import("ol/pixel").Pixel) => Promise<import("ol/Feature").FeatureLike[]>;
-        getData: (pixel: import("ol/pixel").Pixel) => Float32Array | Uint8ClampedArray | Uint8Array | DataView | null;
-        isVisible: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => boolean;
-        getAttributions: (view?: import("ol").View | import("ol/View").ViewStateLayerStateExtent | undefined) => 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: () => OlMap | null;
-        setMap: (map: OlMap | null) => void;
-        setSource: (source: Source | null) => void;
-        getRenderer: () => import("ol/renderer/Layer").default<any> | null;
-        hasRenderer: () => boolean;
-        getBackground: () => false | import("ol/layer/Base").BackgroundColor;
-        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[];
-        getExtent: () => import("ol/extent").Extent | undefined;
-        getMaxResolution: () => number;
-        getMinResolution: () => number;
-        getMinZoom: () => number;
-        getMaxZoom: () => number;
-        getOpacity: () => number;
-        getSourceState: () => import("ol/source/Source").State;
-        getVisible: () => boolean;
-        getZIndex: () => number | undefined;
-        setBackground: (background?: import("ol/layer/Base").BackgroundColor | undefined) => void;
-        setExtent: (extent: import("ol/extent").Extent | undefined) => void;
-        setMaxResolution: (maxResolution: number) => void;
-        setMinResolution: (minResolution: number) => void;
-        setMaxZoom: (maxZoom: number) => void;
-        setMinZoom: (minZoom: number) => void;
-        setOpacity: (opacity: number) => void;
-        setVisible: (visible: boolean) => void;
-        setZIndex: (zindex: number) => void;
-        get: (key: string) => any;
-        getKeys: () => string[];
-        getProperties: () => {
-            [x: string]: any;
-        };
-        getPropertiesInternal: () => {
-            [x: string]: any;
-        } | null;
-        hasProperties: () => boolean;
-        notify: (key: string, oldValue: any) => void;
-        addChangeListener: (key: string, listener: import("ol/events").Listener) => void;
-        removeChangeListener: (key: string, listener: import("ol/events").Listener) => void;
-        set: (key: string, value: any, silent?: boolean | undefined) => void;
-        setProperties: (values: {
-            [x: string]: any;
-        }, silent?: boolean | undefined) => void;
-        unset: (key: string, silent?: boolean | undefined) => void;
-        changed: () => void;
-        getRevision: () => number;
-        dispatchEvent: (event: string | BaseEvent) => boolean | undefined;
-        getListeners: (type: string) => import("ol/events").Listener[] | undefined;
-        hasListener: (type?: string | undefined) => boolean;
-        dispose: () => void;
-    };
-} & typeof Layer;
-/**
- * Common class for Maplibre and Maplibre and potential other fork from Maplibre.
- * It's used to share code between Maplibre and Maplibre layers without importing both libs.
- * @private
- */
-declare class MapGlLayer extends MapGlLayer_base {
-    loaded: boolean;
-    mbMap?: AnyMapGlMap;
-    get apiKey(): string;
-    set apiKey(newValue: string);
-    get apiKeyName(): string;
-    set apiKeyName(newValue: string);
-    get style(): string;
-    set style(newValue: string);
-    get url(): string;
-    set url(newValue: string);
-    get queryRenderedFeaturesOptions(): maplibregl.QueryRenderedFeaturesOptions;
-    set queryRenderedFeaturesOptions(newValue: maplibregl.QueryRenderedFeaturesOptions);
-    constructor(options: MapGlLayerOptions);
-    /**
-     * Initialize the layer and listen to feature clicks.
-     * @param {ol/Map~Map} map
-     */
-    attachToMap(map: OlMap): void;
-    /**
-     * Terminate what was initialized in init function. Remove layer, events...
-     */
-    detachFromMap(): void;
-    /**
-     * Create the Maplibre map.
-     * @private
-     */
-    loadMbMap(): void;
-    getStyle(): string;
-    createMap(options: {
-        [id: string]: any;
-    }): AnyMapGlMap;
-    updateMbMap(): void;
-}
-export default MapGlLayer;

package/ol/layers/MapGlLayer.js

@@ -1,144 +0,0 @@
-import Source from 'ol/source/Source';
-import BaseEvent from 'ol/events/Event';
-import Layer from 'ol/layer/Layer';
-import debounce from 'lodash.debounce';
-import { getUrlWithParams, getMapGlCopyrights } from '../../common/utils';
-import MobilityLayerMixin from '../mixins/MobilityLayerMixin';
-/**
- * Common class for Maplibre and Maplibre and potential other fork from Maplibre.
- * It's used to share code between Maplibre and Maplibre layers without importing both libs.
- * @private
- */
-class MapGlLayer extends MobilityLayerMixin(Layer) {
-    get apiKey() {
-        return this.get('apiKey');
-    }
-    set apiKey(newValue) {
-        this.set('apiKey', newValue);
-    }
-    get apiKeyName() {
-        return this.get('apiKeyName');
-    }
-    set apiKeyName(newValue) {
-        this.set('apiKeyName', newValue);
-    }
-    get style() {
-        return this.get('style');
-    }
-    set style(newValue) {
-        this.set('style', newValue);
-    }
-    get url() {
-        return this.get('url');
-    }
-    set url(newValue) {
-        this.set('url', newValue);
-    }
-    get queryRenderedFeaturesOptions() {
-        return this.get('queryRenderedFeaturesOptions');
-    }
-    set queryRenderedFeaturesOptions(newValue) {
-        this.set('queryRenderedFeaturesOptions', newValue);
-    }
-    constructor(options) {
-        super(Object.assign(Object.assign({ source: new Source({
-                attributions: () => {
-                    return (this.mbMap && getMapGlCopyrights(this.mbMap)) || [];
-                },
-            }), apiKeyName: 'key', style: 'travic_v2', url: 'https://maps.geops.io' }, (options || {})), { 
-            // @ts-expect-error mapOptions must be saved by the mixin in this.options
-            mapOptions: Object.assign({ interactive: false, trackResize: false, attributionControl: false }, ((options === null || options === void 0 ? void 0 : options.mapOptions) || {})), queryRenderedFeaturesOptions: Object.assign({}, ((options === null || options === void 0 ? void 0 : options.queryRenderedFeaturesOptions) || {})) }));
-    }
-    /**
-     * Initialize the layer and listen to feature clicks.
-     * @param {ol/Map~Map} map
-     */
-    attachToMap(map) {
-        super.attachToMap(map);
-        this.loadMbMap();
-        const updateMbMapDebounced = debounce(this.updateMbMap.bind(this), 150);
-        this.olListenersKeys.push(this.on('propertychange', (evt) => {
-            if (/(apiKey|apiKeyName|url|style)/.test(evt.key)) {
-                updateMbMapDebounced();
-            }
-        }));
-    }
-    /**
-     * Terminate what was initialized in init function. Remove layer, events...
-     */
-    detachFromMap() {
-        if (this.mbMap) {
-            // 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 Maplibre map.
-     * @private
-     */
-    loadMbMap() {
-        var _a, _b, _c;
-        this.loaded = false;
-        this.olListenersKeys.push(
-        // @ts-ignore
-        (_a = this.map) === null || _a === void 0 ? void 0 : _a.on('change:target', this.loadMbMap.bind(this)));
-        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.bind(this)));
-            return;
-        }
-        const container = document.createElement('div');
-        container.style.position = 'absolute';
-        container.style.width = '100%';
-        container.style.height = '100%';
-        /**
-         * A Maplibre map
-         * @type {maplibregl.Map}
-         */
-        this.mbMap = this.createMap(Object.assign({ style: this.getStyle(), container }, (((_c = this.options) === null || _c === void 0 ? void 0 : _c.mapOptions) || {})));
-        this.mbMap.on('sourcedata', () => {
-            var _a;
-            (_a = this.getSource()) === null || _a === void 0 ? void 0 : _a.refresh(); // Refresh attribution
-        });
-        this.mbMap.once('load', () => {
-            this.loaded = true;
-            this.dispatchEvent(new BaseEvent('load'));
-        });
-    }
-    getStyle() {
-        // If the style is a complete style object, use it directly.
-        if (this.style &&
-            typeof this.style === 'object' &&
-            this.style.name &&
-            this.style.version) {
-            return this.style;
-        }
-        // If the url set is already a complete style url, use it directly.
-        if (this.url.includes('style.json')) {
-            return this.url;
-        }
-        /// Otherwise build the complete style url.
-        return getUrlWithParams(`${this.url}/styles/${this.style}/style.json`, {
-            [this.apiKeyName]: this.apiKey,
-        }).toString();
-    }
-    // eslint-disable-next-line class-methods-use-this, @typescript-eslint/no-unused-vars
-    createMap(options) {
-        throw new Error('createMap must be implemented in child class');
-    }
-    updateMbMap() {
-        var _a;
-        (_a = this.mbMap) === null || _a === void 0 ? void 0 : _a.setStyle(this.getStyle(), { diff: false });
-    }
-}
-export default MapGlLayer;