@igo2/geo 1.14.2 → 1.14.3

package/lib/feature/shared/store.d.ts

@@ -1,71 +1,71 @@
-import OlFeature from 'ol/Feature';
-import type { default as OlGeometry } from 'ol/geom/Geometry';
-import { EntityKey, EntityStore } from '@igo2/common';
-import { FeatureDataSource } from '../../datasource';
-import { VectorLayer } from '../../layer';
-import { IgoMap } from '../../map';
-import { FeatureMotion } from './feature.enums';
-import { Feature, FeatureStoreOptions } from './feature.interfaces';
-/**
- * The class is a specialized version of an EntityStore that stores
- * features and the map layer to display them on. Synchronization
- * between the store and the layer is handled by strategies.
- */
-export declare class FeatureStore<T extends Feature = Feature> extends EntityStore<T> {
-    /**
-     * Vector layer to display the features on
-     */
-    layer: VectorLayer;
-    /**
-     * The map the layer is bound to
-     */
-    readonly map: IgoMap;
-    /**
-     * The layer's data source
-     */
-    get source(): FeatureDataSource;
-    constructor(entities: T[], options: FeatureStoreOptions);
-    /**
-     * Bind this store to a vector layer
-     * @param layer Vector layer
-     * @returns Feature store
-     */
-    bindLayer(layer: VectorLayer): FeatureStore;
-    /**
-     * Set the layer's features and perform a motion to make them visible. Strategies
-     * make extensive use of that method.
-     * @param features Features
-     * @param motion Optional: The type of motion to perform
-     */
-    setLayerFeatures(features: Feature[], motion?: FeatureMotion, viewScale?: [number, number, number, number], areaRatio?: number, getId?: (Feature: any) => EntityKey): void;
-    /**
-     * Set the store's features from an array of OL features.
-     * @param olFeatures Ol features
-     */
-    setStoreOlFeatures(olFeatures: OlFeature<OlGeometry>[]): void;
-    /**
-     * Remove all features from the layer
-     */
-    clearLayer(): void;
-    /**
-     * Check wether a layer is bound or not and throw an error if not.
-     */
-    private checkLayer;
-    /**
-     * Set the layer's features and perform a motion to make them visible.
-     * @param features Openlayers feature objects
-     * @param motion Optional: The type of motion to perform
-     */
-    setLayerOlFeatures(olFeatures: OlFeature<OlGeometry>[], motion?: FeatureMotion, viewScale?: [number, number, number, number], areaRatio?: number): void;
-    setLayerExtent(): void;
-    /**
-     * Add features to the the layer
-     * @param features Openlayers feature objects
-     */
-    private addOlFeaturesToLayer;
-    /**
-     * Remove features from the the layer
-     * @param features Openlayers feature objects
-     */
-    private removeOlFeaturesFromLayer;
-}
+import OlFeature from 'ol/Feature';
+import type { default as OlGeometry } from 'ol/geom/Geometry';
+import { EntityKey, EntityStore } from '@igo2/common';
+import { FeatureDataSource } from '../../datasource';
+import { VectorLayer } from '../../layer';
+import { IgoMap } from '../../map';
+import { FeatureMotion } from './feature.enums';
+import { Feature, FeatureStoreOptions } from './feature.interfaces';
+/**
+ * The class is a specialized version of an EntityStore that stores
+ * features and the map layer to display them on. Synchronization
+ * between the store and the layer is handled by strategies.
+ */
+export declare class FeatureStore<T extends Feature = Feature> extends EntityStore<T> {
+    /**
+     * Vector layer to display the features on
+     */
+    layer: VectorLayer;
+    /**
+     * The map the layer is bound to
+     */
+    readonly map: IgoMap;
+    /**
+     * The layer's data source
+     */
+    get source(): FeatureDataSource;
+    constructor(entities: T[], options: FeatureStoreOptions);
+    /**
+     * Bind this store to a vector layer
+     * @param layer Vector layer
+     * @returns Feature store
+     */
+    bindLayer(layer: VectorLayer): FeatureStore;
+    /**
+     * Set the layer's features and perform a motion to make them visible. Strategies
+     * make extensive use of that method.
+     * @param features Features
+     * @param motion Optional: The type of motion to perform
+     */
+    setLayerFeatures(features: Feature[], motion?: FeatureMotion, viewScale?: [number, number, number, number], areaRatio?: number, getId?: (Feature: any) => EntityKey): void;
+    /**
+     * Set the store's features from an array of OL features.
+     * @param olFeatures Ol features
+     */
+    setStoreOlFeatures(olFeatures: OlFeature<OlGeometry>[]): void;
+    /**
+     * Remove all features from the layer
+     */
+    clearLayer(): void;
+    /**
+     * Check wether a layer is bound or not and throw an error if not.
+     */
+    private checkLayer;
+    /**
+     * Set the layer's features and perform a motion to make them visible.
+     * @param features Openlayers feature objects
+     * @param motion Optional: The type of motion to perform
+     */
+    setLayerOlFeatures(olFeatures: OlFeature<OlGeometry>[], motion?: FeatureMotion, viewScale?: [number, number, number, number], areaRatio?: number): void;
+    setLayerExtent(): void;
+    /**
+     * Add features to the the layer
+     * @param features Openlayers feature objects
+     */
+    private addOlFeaturesToLayer;
+    /**
+     * Remove features from the the layer
+     * @param features Openlayers feature objects
+     */
+    private removeOlFeaturesFromLayer;
+}

package/lib/feature/shared/strategies/in-map-extent.d.ts

@@ -1,52 +1,52 @@
-import { EntityStoreStrategy } from '@igo2/common';
-import { FeatureStore } from '../store';
-import { FeatureStoreInMapExtentStrategyOptions } from '../feature.interfaces';
-/**
- * This strategy maintain the store features updated while the map is moved.
- * The features's state inside the map are tagged inMapExtent = true;
- */
-export declare class FeatureStoreInMapExtentStrategy extends EntityStoreStrategy {
-    protected options: FeatureStoreInMapExtentStrategyOptions;
-    /**
-     * Subscription to the store's OL source changes
-     */
-    private stores$$;
-    private states$$;
-    private empty$$;
-    constructor(options: FeatureStoreInMapExtentStrategyOptions);
-    /**
-     * Bind this strategy to a store and start watching for Ol source changes
-     * @param store Feature store
-     */
-    bindStore(store: FeatureStore): void;
-    /**
-     * Unbind this strategy from a store and stop watching for Ol source changes
-     * @param store Feature store
-     */
-    unbindStore(store: FeatureStore): void;
-    /**
-     * Start watching all stores already bound to that strategy at once.
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop watching all stores bound to that strategy
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Watch for a store's  OL source changes
-     * @param store Feature store
-     */
-    private watchStore;
-    private updateEntitiesInExtent;
-    /**
-     * Stop watching for a store's OL source changes
-     * @param store Feature store
-     */
-    private unwatchStore;
-    /**
-     * Stop watching for OL source changes in all stores.
-     */
-    private unwatchAll;
-}
+import { EntityStoreStrategy } from '@igo2/common';
+import { FeatureStore } from '../store';
+import { FeatureStoreInMapExtentStrategyOptions } from '../feature.interfaces';
+/**
+ * This strategy maintain the store features updated while the map is moved.
+ * The features's state inside the map are tagged inMapExtent = true;
+ */
+export declare class FeatureStoreInMapExtentStrategy extends EntityStoreStrategy {
+    protected options: FeatureStoreInMapExtentStrategyOptions;
+    /**
+     * Subscription to the store's OL source changes
+     */
+    private stores$$;
+    private states$$;
+    private empty$$;
+    constructor(options: FeatureStoreInMapExtentStrategyOptions);
+    /**
+     * Bind this strategy to a store and start watching for Ol source changes
+     * @param store Feature store
+     */
+    bindStore(store: FeatureStore): void;
+    /**
+     * Unbind this strategy from a store and stop watching for Ol source changes
+     * @param store Feature store
+     */
+    unbindStore(store: FeatureStore): void;
+    /**
+     * Start watching all stores already bound to that strategy at once.
+     * @internal
+     */
+    protected doActivate(): void;
+    /**
+     * Stop watching all stores bound to that strategy
+     * @internal
+     */
+    protected doDeactivate(): void;
+    /**
+     * Watch for a store's  OL source changes
+     * @param store Feature store
+     */
+    private watchStore;
+    private updateEntitiesInExtent;
+    /**
+     * Stop watching for a store's OL source changes
+     * @param store Feature store
+     */
+    private unwatchStore;
+    /**
+     * Stop watching for OL source changes in all stores.
+     */
+    private unwatchAll;
+}

package/lib/feature/shared/strategies/in-map-resolution.d.ts

@@ -1,52 +1,52 @@
-import { EntityStoreStrategy } from '@igo2/common';
-import { FeatureStore } from '../store';
-import { FeatureStoreInMapResolutionStrategyOptions } from '../feature.interfaces';
-/**
- * This strategy maintain the store features updated while the map is scrolled.
- * The features's state inside the map's resolution are tagged inMapResolution = true;
- */
-export declare class FeatureStoreInMapResolutionStrategy extends EntityStoreStrategy {
-    protected options: FeatureStoreInMapResolutionStrategyOptions;
-    /**
-     * Subscription to the store's OL source changes
-     */
-    private stores$$;
-    private resolution$$;
-    private empty$$;
-    constructor(options: FeatureStoreInMapResolutionStrategyOptions);
-    /**
-     * Bind this strategy to a store and start watching for Ol source changes
-     * @param store Feature store
-     */
-    bindStore(store: FeatureStore): void;
-    /**
-     * Unbind this strategy from a store and stop watching for Ol source changes
-     * @param store Feature store
-     */
-    unbindStore(store: FeatureStore): void;
-    /**
-     * Start watching all stores already bound to that strategy at once.
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop watching all stores bound to that strategy
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Watch for a store's  OL source changes
-     * @param store Feature store
-     */
-    private watchStore;
-    private updateEntitiesInResolution;
-    /**
-     * Stop watching for a store's OL source changes
-     * @param store Feature store
-     */
-    private unwatchStore;
-    /**
-     * Stop watching for OL source changes in all stores.
-     */
-    private unwatchAll;
-}
+import { EntityStoreStrategy } from '@igo2/common';
+import { FeatureStore } from '../store';
+import { FeatureStoreInMapResolutionStrategyOptions } from '../feature.interfaces';
+/**
+ * This strategy maintain the store features updated while the map is scrolled.
+ * The features's state inside the map's resolution are tagged inMapResolution = true;
+ */
+export declare class FeatureStoreInMapResolutionStrategy extends EntityStoreStrategy {
+    protected options: FeatureStoreInMapResolutionStrategyOptions;
+    /**
+     * Subscription to the store's OL source changes
+     */
+    private stores$$;
+    private resolution$$;
+    private empty$$;
+    constructor(options: FeatureStoreInMapResolutionStrategyOptions);
+    /**
+     * Bind this strategy to a store and start watching for Ol source changes
+     * @param store Feature store
+     */
+    bindStore(store: FeatureStore): void;
+    /**
+     * Unbind this strategy from a store and stop watching for Ol source changes
+     * @param store Feature store
+     */
+    unbindStore(store: FeatureStore): void;
+    /**
+     * Start watching all stores already bound to that strategy at once.
+     * @internal
+     */
+    protected doActivate(): void;
+    /**
+     * Stop watching all stores bound to that strategy
+     * @internal
+     */
+    protected doDeactivate(): void;
+    /**
+     * Watch for a store's  OL source changes
+     * @param store Feature store
+     */
+    private watchStore;
+    private updateEntitiesInResolution;
+    /**
+     * Stop watching for a store's OL source changes
+     * @param store Feature store
+     */
+    private unwatchStore;
+    /**
+     * Stop watching for OL source changes in all stores.
+     */
+    private unwatchAll;
+}

package/lib/feature/shared/strategies/index.d.ts

@@ -1,5 +1,5 @@
-export * from './in-map-extent';
-export * from './in-map-resolution';
-export * from './loading';
-export * from './loading-layer';
-export * from './selection';
+export * from './in-map-extent';
+export * from './in-map-resolution';
+export * from './loading';
+export * from './loading-layer';
+export * from './selection';

package/lib/feature/shared/strategies/loading-layer.d.ts

@@ -1,59 +1,59 @@
-import { EntityStoreStrategy } from '@igo2/common';
-import { FeatureStore } from '../store';
-import { FeatureStoreLoadingLayerStrategyOptions } from '../feature.interfaces';
-/**
- * This strategy loads a layer's features into it's store counterpart.
- * The layer -> store binding is a one-way binding. That means any OL feature
- * added to the layer will be added to the store but the opposite is false.
- *
- * Important: In it's current state, this strategy is to meant to be combined
- * with a standard Loading strategy and it would probably cause recursion issues.
- */
-export declare class FeatureStoreLoadingLayerStrategy extends EntityStoreStrategy {
-    protected options: FeatureStoreLoadingLayerStrategyOptions;
-    /**
-     * Subscription to the store's OL source changes
-     */
-    private stores$$;
-    constructor(options: FeatureStoreLoadingLayerStrategyOptions);
-    /**
-     * Bind this strategy to a store and start watching for Ol source changes
-     * @param store Feature store
-     */
-    bindStore(store: FeatureStore): void;
-    /**
-     * Unbind this strategy from a store and stop watching for Ol source changes
-     * @param store Feature store
-     */
-    unbindStore(store: FeatureStore): void;
-    /**
-     * Start watching all stores already bound to that strategy at once.
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop watching all stores bound to that strategy
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Watch for a store's  OL source changes
-     * @param store Feature store
-     */
-    private watchStore;
-    /**
-     * Stop watching for a store's OL source changes
-     * @param store Feature store
-     */
-    private unwatchStore;
-    /**
-     * Stop watching for OL source changes in all stores.
-     */
-    private unwatchAll;
-    /**
-     * Load features from an OL source into a  store or clear the store if the source is empty
-     * @param features Store filtered features
-     * @param store Feature store
-     */
-    private onSourceChanges;
-}
+import { EntityStoreStrategy } from '@igo2/common';
+import { FeatureStore } from '../store';
+import { FeatureStoreLoadingLayerStrategyOptions } from '../feature.interfaces';
+/**
+ * This strategy loads a layer's features into it's store counterpart.
+ * The layer -> store binding is a one-way binding. That means any OL feature
+ * added to the layer will be added to the store but the opposite is false.
+ *
+ * Important: In it's current state, this strategy is to meant to be combined
+ * with a standard Loading strategy and it would probably cause recursion issues.
+ */
+export declare class FeatureStoreLoadingLayerStrategy extends EntityStoreStrategy {
+    protected options: FeatureStoreLoadingLayerStrategyOptions;
+    /**
+     * Subscription to the store's OL source changes
+     */
+    private stores$$;
+    constructor(options: FeatureStoreLoadingLayerStrategyOptions);
+    /**
+     * Bind this strategy to a store and start watching for Ol source changes
+     * @param store Feature store
+     */
+    bindStore(store: FeatureStore): void;
+    /**
+     * Unbind this strategy from a store and stop watching for Ol source changes
+     * @param store Feature store
+     */
+    unbindStore(store: FeatureStore): void;
+    /**
+     * Start watching all stores already bound to that strategy at once.
+     * @internal
+     */
+    protected doActivate(): void;
+    /**
+     * Stop watching all stores bound to that strategy
+     * @internal
+     */
+    protected doDeactivate(): void;
+    /**
+     * Watch for a store's  OL source changes
+     * @param store Feature store
+     */
+    private watchStore;
+    /**
+     * Stop watching for a store's OL source changes
+     * @param store Feature store
+     */
+    private unwatchStore;
+    /**
+     * Stop watching for OL source changes in all stores.
+     */
+    private unwatchAll;
+    /**
+     * Load features from an OL source into a  store or clear the store if the source is empty
+     * @param features Store filtered features
+     * @param store Feature store
+     */
+    private onSourceChanges;
+}

package/lib/feature/shared/strategies/loading.d.ts

@@ -1,75 +1,75 @@
-import { EntityStoreStrategy } from '@igo2/common';
-import { FeatureMotion } from '../feature.enums';
-import { FeatureStoreLoadingStrategyOptions } from '../feature.interfaces';
-import { FeatureStore } from '../store';
-/**
- * This strategy loads a store's features into it's layer counterpart.
- * The store -> layer binding is a one-way binding. That means any entity
- * added to the store will be added to the layer but the opposite is false.
- *
- * Important: This strategy observes filtered entities, not raw entities. This
- * is not configurable yet.
- */
-export declare class FeatureStoreLoadingStrategy extends EntityStoreStrategy {
-    protected options: FeatureStoreLoadingStrategyOptions;
-    /**
-     * Subscription to the store's features
-     */
-    private stores$$;
-    private motion;
-    constructor(options: FeatureStoreLoadingStrategyOptions);
-    /**
-     * Bind this strategy to a store and start watching for entities changes
-     * @param store Feature store
-     */
-    bindStore(store: FeatureStore): void;
-    /**
-     * Unbind this strategy from a store and stop watching for entities changes
-     * @param store Feature store
-     */
-    unbindStore(store: FeatureStore): void;
-    /**
-     * Define the motion to apply on load
-     * @param motion Feature motion
-     */
-    setMotion(motion: FeatureMotion): void;
-    /**
-     * Start watching all stores already bound to that strategy at once.
-     * @internal
-     */
-    protected doActivate(): void;
-    /**
-     * Stop watching all stores bound to that strategy
-     * @internal
-     */
-    protected doDeactivate(): void;
-    /**
-     * Watch for entities changes in a store.
-     * Important: Never observe a store's sorted entities. It makes no sense
-     * to display sorted entities (instead of unsorted) on a layer and it
-     * would potentially result in a lot of useless computation.
-     * @param store Feature store
-     */
-    private watchStore;
-    /**
-     * Stop watching for entities changes in a store.
-     * @param store Feature store
-     */
-    private unwatchStore;
-    /**
-     * Stop watching for entities changes in all stores.
-     */
-    private unwatchAll;
-    /**
-     * Load features into a layer or clear the layer if the array of features is empty.
-     * @param features Store filtered features
-     * @param store Feature store
-     */
-    private onFeaturesChange;
-    /**
-     * Selects the best motion
-     * @param store A FeatureStore to apply the motion
-     * @returns The motion selected
-     */
-    private selectMotion;
-}
+import { EntityStoreStrategy } from '@igo2/common';
+import { FeatureMotion } from '../feature.enums';
+import { FeatureStoreLoadingStrategyOptions } from '../feature.interfaces';
+import { FeatureStore } from '../store';
+/**
+ * This strategy loads a store's features into it's layer counterpart.
+ * The store -> layer binding is a one-way binding. That means any entity
+ * added to the store will be added to the layer but the opposite is false.
+ *
+ * Important: This strategy observes filtered entities, not raw entities. This
+ * is not configurable yet.
+ */
+export declare class FeatureStoreLoadingStrategy extends EntityStoreStrategy {
+    protected options: FeatureStoreLoadingStrategyOptions;
+    /**
+     * Subscription to the store's features
+     */
+    private stores$$;
+    private motion;
+    constructor(options: FeatureStoreLoadingStrategyOptions);
+    /**
+     * Bind this strategy to a store and start watching for entities changes
+     * @param store Feature store
+     */
+    bindStore(store: FeatureStore): void;
+    /**
+     * Unbind this strategy from a store and stop watching for entities changes
+     * @param store Feature store
+     */
+    unbindStore(store: FeatureStore): void;
+    /**
+     * Define the motion to apply on load
+     * @param motion Feature motion
+     */
+    setMotion(motion: FeatureMotion): void;
+    /**
+     * Start watching all stores already bound to that strategy at once.
+     * @internal
+     */
+    protected doActivate(): void;
+    /**
+     * Stop watching all stores bound to that strategy
+     * @internal
+     */
+    protected doDeactivate(): void;
+    /**
+     * Watch for entities changes in a store.
+     * Important: Never observe a store's sorted entities. It makes no sense
+     * to display sorted entities (instead of unsorted) on a layer and it
+     * would potentially result in a lot of useless computation.
+     * @param store Feature store
+     */
+    private watchStore;
+    /**
+     * Stop watching for entities changes in a store.
+     * @param store Feature store
+     */
+    private unwatchStore;
+    /**
+     * Stop watching for entities changes in all stores.
+     */
+    private unwatchAll;
+    /**
+     * Load features into a layer or clear the layer if the array of features is empty.
+     * @param features Store filtered features
+     * @param store Feature store
+     */
+    private onFeaturesChange;
+    /**
+     * Selects the best motion
+     * @param store A FeatureStore to apply the motion
+     * @returns The motion selected
+     */
+    private selectMotion;
+}