Open Pioneer Trails Packages
    Preparing search index...

    Interface OgcFeatureVectorSourceOptions

    These are properties for OGC API Features vector source.

    interface OgcFeatureVectorSourceOptions {
        additionalOptions?: Options<Feature<Geometry, { [x: string]: any }>>;
        attributions?: AttributionLike;
        baseUrl: string;
        collectionId: string;
        crs?: string;
        limit?: number;
        maxConcurrentRequests?: number;
        rewriteUrl?: (url: URL) => URL | undefined;
        strategy?: OgcFetchStrategy;
    }
    Index

    Properties

    additionalOptions?: Options<Feature<Geometry, { [x: string]: any }>>

    Optional additional options for the VectorSource.

    attributions?: AttributionLike

    Optional attribution for the vector source (e.g. copyright hints).

    If set, this property is passed to the map as attribution information for this vector source. If the property is not set or undefined, the vector source will check if the collection metadata contains a non-standard attribution property and use it as attribution. Setting the this value to the empty string will explicitly disable attributions for this vector source, even if the collection metadata contains an attribution property.

    baseUrl: string

    The base-URL right to the "/collections"-part

    collectionId: string

    The collection-ID

    crs?: string

    The URL to the EPSG-Code, e.g. http://www.opengis.net/def/crs/EPSG/0/25832 If not provided, the vector source will attempt to use the map's CRS if supported by the collection, or fall back to CRS84 otherwise.

    limit?: number

    The maximum number of features to fetch within a single request. Corresponds to the limit parameter in the URL.

    When the offset strategy is used for feature fetching, the limit is used for the page size

    Defaults to 5000 for Next-Strategy. Defaults to 2500 for Offset-Strategy.

    maxConcurrentRequests?: number

    The maximum number of concurrent requests. Defaults to 6.

    rewriteUrl?: (url: URL) => URL | undefined

    Use this function to rewrite the URL used to fetch features from the OGC API Features service. This is useful, for example, to filter the OGC service on the server side.

    NOTE: Do not update the url argument. Return a new URL instance instead.

    NOTE: Be careful with existing URL parameters. The vector source may not work correctly if predefined parameters (such as the CRS or the response format) are overwritten. The vector source might add additional parameters to its request URLs in the future.

    strategy?: OgcFetchStrategy

    Use this property to define the feature fetching strategy. Allowed value are offset and next. By default, the vector source attempts to detect the server's capabilities and will prefer "offset", if possible.