@igo2/geo/lib/feature/shared/store.d.ts

IGO Library

import { EntityKey, EntityStore } from '@igo2/common/entity';
import OlFeature from 'ol/Feature';
import type { default as OlGeometry } from 'ol/geom/Geometry';
import { Document } from 'flexsearch';
import { FeatureDataSource } from '../../datasource/shared/datasources';
import { VectorLayer } from '../../layer/shared/layers/vector-layer';
import type { IgoMap } from '../../map/shared';
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;
    /**
     * The searchable index of loaded feature. Computed if strategy is provided
     */
    set searchDocument(v: Document<T>);
    get searchDocument(): Document<T>;
    private _searchDocument;
    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;
}