mobility-toolbox-js 3.0.1-beta.0 → 3.0.1-beta.2

package/ol/layers/MaplibreStyleLayer.d.ts

@@ -1,9 +1,9 @@
 import { FeatureState } from 'maplibre-gl';
 import { Feature, Map } from 'ol';
 import { Coordinate } from 'ol/coordinate';
+import { EventsKey } from 'ol/events';
 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';
@@ -15,131 +15,81 @@ export type MaplibreStyleLayerOptions = {
     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").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.
+ * Layer that helps show/hide a specific subset of style layers of a [MaplibreLayer](./MaplibreLayer.js~MaplibreLayer.html).
  *
  * @example
- * import { MapboxLayer, MapboxStyleLayer } from 'mobility-toolbox-js/ol';
+ * import { MaplibreLayer, MaplibreStyleLayer } from 'mobility-toolbox-js/ol';
  *
- * const maplibreLayer = new MapboxLayer({
- *   url: 'https://maps.geops.io/styles/travic_v2/style.json?key=[yourApiKey]',
+ * const maplibreLayer = new MaplibreLayer({
+ *   apiKey: 'yourApiKey',
  * });
  *
- * const layer = new MapboxStyleLayer({
+ * const layer = new MaplibreStyleLayer({
  *   maplibreLayer: maplibreLayer,
- *   styleLayersFilter: () => {},
+ *   layersFilter: (layer) => {
+ *     // show/hide only style layers related to stations
+ *     return /station/.test(layer.id);
+ *   },
  * });
  *
- * @classproperty {ol/Map~Map} map - The map where the layer is displayed.
+ * @see <a href="/example/ol-maplibre-style-layer">OpenLayers MaplibreStyle layer example</a>
  * @extends {ol/layer/Layer~Layer}
+ * @public
  */
-declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
+declare class MaplibreStyleLayer extends Layer {
     highlightedFeatures: Feature[];
+    olEventsKeys: EventsKey[];
     selectedFeatures: Feature[];
+    get beforeId(): string;
+    set beforeId(newValue: string | undefined);
+    get layers(): maplibregl.AddLayerObject[];
+    set layers(newValue: maplibregl.AddLayerObject[]);
+    get layersFilter(): (layer: maplibregl.LayerSpecification) => boolean;
+    set layersFilter(newValue: (layer: maplibregl.LayerSpecification) => boolean);
+    /**
+     * @deprecated Use MaplibreStyleLayer.maplibreLayer instead.
+     */
+    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 Use MaplibreStyleLayer.layer instead.
+     */
+    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[]);
     /**
      * 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 {string} [options.beforeId] The style layer id to use when the options.layers property is defined, unsused otherwise.
      * @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 {MaplibreLayer} [options.maplibreLayer] The MaplibreLayer to use.
      * @param {FilterFunction} [options.queryRenderedLayersFilter] Filter function to decide which style layer are available for query.
+     * @param {{[id: string]:maplibregl.SourceSpecification}} [options.sources] The sources to add to the style on load.
+     * @public
      */
     constructor(options?: MaplibreStyleLayerOptions);
-    /** @private */
     addLayers(): void;
-    /** @private */
     addSources(): void;
     applyLayoutVisibility(evt?: ObjectEvent): void;
     /**
@@ -149,9 +99,11 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      */
     attachToMap(map: Map): void;
     /**
-     * Create a copy of the MapboxStyleLayer.
-     * @param {Object} newOptions Options to override.
-     * @return {MapboxStyleLayer} A MapboxStyleLayer.
+     * Create a copy of the MaplibreStyleLayer.
+     *
+     * @param {Object} newOptions Options to override. See constructor.
+     * @return {MapboxStyleLayer} A MaplibreStyleLayer.
+     * @public
      */
     clone(newOptions: MaplibreStyleLayerOptions): MaplibreStyleLayer;
     createRenderer(): MaplibreStyleLayerRenderer;
@@ -164,33 +116,32 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * 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.
+     * @deprecated Use getFeatureInfoAtCoordinate([layer], coordinate) from mobility-toolbox-ol package instead.
      */
     getFeatureInfoAtCoordinate(coordinate: Coordinate): Promise<LayerGetFeatureInfoResponse>;
     /**
      * Highlight a list of features.
      * @param {Array<ol/Feature~Feature>} [features=[]] Features to highlight.
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     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
+     * @deprecated Use layer.setFeatureState(features, {selected: true|false}) instead.
      */
     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
+     * Set the [feature state](https://maplibre.org/maplibre-style-spec/expressions/#feature-state) of the features.
+     *
+     * @param {ol/Feature~Feature[]} features
+     * @param {{[key: string]: any}} state The feature state
      * @public
      */
     setFeatureState(features: Feature[], state: FeatureState): void;
@@ -198,40 +149,9 @@ declare class MaplibreStyleLayer extends MaplibreStyleLayer_base {
      * Set if features are hovered or not.
      * @param {Array<ol/Feature~Feature>} features
      * @param {boolean} state Is the feature hovered
-     * @private
+     * @deprecated Use layer.setFeatureState(features, {hover: true|false}) instead.
      */
     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[]);
+    setMapInternal(map: Map): void;
 }
 export default MaplibreStyleLayer;