@giro3d/giro3d/sources/FeatureSource.d.ts

A JS/WebGL framework for 3D geospatial data visualization

import type { Feature } from 'ol';
import { EventDispatcher } from 'three';
import type CoordinateSystem from '../core/geographic/CoordinateSystem';
import type Extent from '../core/geographic/Extent';
export interface GetFeatureResult {
    /**
     * The resulting features.
     */
    features: Readonly<Feature[]>;
}
export interface GetFeatureRequest {
    /**
     * The extent of the request. The source will make the best effort to return features
     * limited to this extent, but may return more features.
     */
    extent: Extent;
    /**
     * Optional abort signal to cancel the feature request.
     */
    signal?: AbortSignal;
}
export interface FeatureSourceEventMap {
    /**
     * Raised when the content of the feature source have changed.
     */
    updated: unknown;
}
/**
 * Interface for feature sources.
 *
 * > [!note]
 * > To implement a feature source, you can use the {@link FeatureSourceBase} base class for convenience.
 */
export interface FeatureSource extends EventDispatcher<FeatureSourceEventMap> {
    /**
     * Initializes the source. The source is not useable before being initialized.
     */
    initialize(options: {
        /**
         * The coordinate system of features that are generated by this source.
         * The source is responsible for reprojecting features if their original
         * CRS is different from the target.
         */
        targetCoordinateSystem: CoordinateSystem;
    }): Promise<void>;
    /**
     * Gets the features matching the request.
     * @param request - The feature request.
     */
    getFeatures(request: GetFeatureRequest): Promise<GetFeatureResult>;
}
export declare abstract class FeatureSourceBase extends EventDispatcher<FeatureSourceEventMap> implements FeatureSource {
    abstract readonly type: string;
    protected _targetCoordinateSystem: CoordinateSystem | null;
    protected _initialized: boolean;
    constructor();
    initialize(options: {
        targetCoordinateSystem: CoordinateSystem;
    }): Promise<void>;
    /**
     * Raises an event to reload the source.
     */
    update(): void;
    protected throwIfNotInitialized(): void;
    abstract getFeatures(request: GetFeatureRequest): Promise<GetFeatureResult>;
}
//# sourceMappingURL=FeatureSource.d.ts.map