mobility-toolbox-js 3.0.0-beta.2 → 3.0.0-beta.20

package/ol/layers/MaplibreStyleLayer.d.ts

@@ -0,0 +1,242 @@
+import { FeatureState } from 'maplibre-gl';
+import { Feature, Map } from 'ol';
+import { Coordinate } from 'ol/coordinate';
+import { Layer } from 'ol/layer';
+import { ObjectEvent } from 'ol/Object';
+import { Source } from 'ol/source';
+import { FilterFunction } from '../../common/typedefs';
+import { LayerGetFeatureInfoResponse } from '../../types';
+import MaplibreStyleLayerRenderer from '../renderers/MaplibreStyleLayerRenderer';
+import MaplibreLayer, { MaplibreLayerOptions } from './MaplibreLayer';
+export type MaplibreStyleLayerOptions = {
+    beforeId?: string;
+    layers?: maplibregl.AddLayerObject[];
+    layersFilter?: FilterFunction;
+    maplibreLayer?: MaplibreLayer;
+    queryRenderedLayersFilter?: FilterFunction;
+} & MaplibreLayerOptions;
+declare const MaplibreStyleLayer_base: {
+    new (...args: any[]): {
+        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" /**
+         * Set if features are hovered or not.
+         * @param {Array<ol/Feature~Feature>} features
+         * @param {boolean} state Is the feature hovered
+         * @private
+         */).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: number;
+        readonly key: string;
+        readonly map: Map;
+        readonly name: string;
+        olLayer: Layer;
+        parent: Layer<Source, import("ol/renderer/Layer").default<any>>;
+        visible: boolean;
+        on: import("ol/layer/Layer").LayerOnSignature<import("ol/events").EventsKey>;
+        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<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: () => 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: () => import("ol/layer/Base").BackgroundColor | false;
+        getClassName: () => string;
+        getLayerState: (managed?: boolean | 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;
+        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: () => Array<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;
+        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;
+/**
+ * Layer for visualizing a specific set of layer from a MapboxLayer.
+ *
+ * @example
+ * import { MapboxLayer, MapboxStyleLayer } from 'mobility-toolbox-js/ol';
+ *
+ * const maplibreLayer = new MapboxLayer({
+ *   url: 'https://maps.geops.io/styles/travic_v2/style.json?key=[yourApiKey]',
+ * });
+ *
+ * const layer = new MapboxStyleLayer({
+ *   maplibreLayer: maplibreLayer,
+ *   styleLayersFilter: () => {},
+ * });
+ *
+ * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @extends {ol/layer/Layer~Layer}
+ */
+declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
+    highlightedFeatures: Feature[];
+    selectedFeatures: Feature[];
+    /**
+     * Constructor.
+     *
+     * @param {Object} options
+     * @param {MapboxLayer} [options.maplibreLayer] The MaplibreLayer to use.
+     * @param {maplibregl.SourceSpecification[]} [options.sources] The source to add to the style on load.
+     * @param {maplibregl.AddLayerObject[]} [options.layers] The layers to add to the style on load.
+     * @param {FilterFunction} [options.layersFilter] Filter function to decide which style layer to apply visiblity on. If not provided, the 'layers' property is used.
+     * @param {FilterFunction} [options.queryRenderedLayersFilter] Filter function to decide which style layer are available for query.
+     */
+    constructor(options?: MaplibreStyleLayerOptions);
+    /** @private */
+    addLayers(): void;
+    /** @private */
+    addSources(): void;
+    applyLayoutVisibility(evt?: ObjectEvent): void;
+    /**
+     * Initialize the layer.
+     * @param {ol/Map~Map} map the Maplibre map.
+     * @override
+     */
+    attachToMap(map: Map): void;
+    /**
+     * Create a copy of the MapboxStyleLayer.
+     * @param {Object} newOptions Options to override.
+     * @return {MapboxStyleLayer} A MapboxStyleLayer.
+     */
+    clone(newOptions: MaplibreStyleLayerOptions): MaplibreStyleLayer;
+    createRenderer(): MaplibreStyleLayerRenderer;
+    /**
+     * Terminate the layer.
+     * @override
+     */
+    detachFromMap(): void;
+    /**
+     * Request feature information for a given coordinate.
+     * @param {ol/coordinate~Coordinate} coordinate Coordinate to request the information at.
+     * @return {Promise<FeatureInfo>} Promise with features, layer and coordinate.
+     */
+    getFeatureInfoAtCoordinate(coordinate: Coordinate): Promise<LayerGetFeatureInfoResponse>;
+    /**
+     * Highlight a list of features.
+     * @param {Array<ol/Feature~Feature>} [features=[]] Features to highlight.
+     * @private
+     */
+    highlight(features?: Feature[]): void;
+    /**
+     * On Maplibre map load callback function. Add style layers and dynaimc filters.
+     * @private
+     */
+    onLoad(): void;
+    /** @private */
+    removeLayers(): void;
+    /** @private */
+    removeSources(): void;
+    /**
+     * Select a list of features.
+     * @param {Array<ol/Feature~Feature>} [features=[]] Features to select.
+     * @private
+     */
+    select(features?: Feature[]): void;
+    /**
+     * Set the feature state of the features.
+     * @param {Array<ol/Feature~Feature>} features
+     * @param {{[key:string]:boolean}} state The feature state
+     * @public
+     */
+    setFeatureState(features: Feature[], state: FeatureState): void;
+    /**
+     * Set if features are hovered or not.
+     * @param {Array<ol/Feature~Feature>} features
+     * @param {boolean} state Is the feature hovered
+     * @private
+     */
+    setHoverState(features: Feature[], state: boolean): void;
+    get beforeId(): string;
+    set beforeId(newValue: string[]);
+    get layers(): maplibregl.AddLayerObject[];
+    set layers(newValue: maplibregl.AddLayerObject[]);
+    get layersFilter(): (layer: maplibregl.LayerSpecification) => boolean;
+    set layersFilter(newValue: (layer: maplibregl.LayerSpecification) => boolean);
+    get mapboxLayer(): MaplibreLayer | undefined;
+    get maplibreLayer(): MaplibreLayer;
+    set maplibreLayer(newValue: MaplibreLayer);
+    get queryRenderedLayersFilter(): (layer: maplibregl.LayerSpecification) => boolean;
+    set queryRenderedLayersFilter(newValue: (layer: maplibregl.LayerSpecification) => boolean);
+    get sources(): Record<string, maplibregl.SourceSpecification>;
+    set sources(newValue: Record<string, maplibregl.SourceSpecification>);
+    /**
+     * @deprecated
+     */
+    get styleLayer(): maplibregl.AddLayerObject;
+    /**
+     * @deprecated
+     */
+    set styleLayer(newValue: maplibregl.AddLayerObject);
+    /**
+     * Apply visibility to style layers that fits the styleLayersFilter function.
+     */
+    /**
+     * @deprecated
+     */
+    get styleLayers(): maplibregl.AddLayerObject[];
+    /**
+     * @deprecated
+     */
+    set styleLayers(newValue: maplibregl.AddLayerObject[]);
+}
+export default MaplibreStyleLayer;