@vcmap/core
    Preparing search index...

    Class WMSFeatureProvider

    An abstract class providing features for Layers which cannot provide features directly, but can provide features for a given location, e.g. WmsLayer with a getFeatureInfo configuration. In this case, a feature provider can be created for this layer.

    Hierarchy (View Summary)

    Index

    Accessors

    • get className(): string

      Returns string

    Constructors

    Methods

    • Parameters

      • data: any
      • coordinate: Coordinate

      Returns Feature<Geometry, { [x: string]: any }>[]

    • This method must be overwritten by any implementations. Before returning the array of features, be sure to use the getProviderFeature on each feature to ensure all properties and symbols required by the VCM architecture to handle your feature is called: (e.g. return features.map(f => this.getProviderFeature(f));

      Parameters

      • coordinate: Coordinate

        in mercator

      • resolution: number

        meters per pixel for the given location

      • layer: Layer

        the layer to request the features for

      Returns Promise<Feature<Geometry, { [x: string]: any }>[]>

    Properties

    _inRenderingOrder: boolean = false

    Indicates whether the feature provider should only return the first feature. Defaults to false, but is set to true in MapboxFeatureProvider. @link{FeatureProviderInteraction} can be configured to respect this property and only return the first feature when both the interaction and the provider have it set to true.

    "[moduleIdSymbol]"?: string
    extent: Extent | null = null
    featureFormat: FeatureFormat<Feature<Geometry, { [x: string]: any }>> | null

    The feature response format determined by the response type. Use formatOptions to configure the underlying ol.format.Feature

    featureInfoFormat:
        | "GeoJSON"
        | "GML2"
        | "GML3"
        | "GML32"
        | "WMSGetFeatureInfo"
        | "WFS"
        | undefined

    The feature info format, if different from the responseType.

    featureInfoResponseType: string

    The response type of the get feature info response, e.g. text/xml

    headers?: Record<string, string>

    Optional headers to include in GetFeatureInfo requests.

    htmlPositionFeatureTitle?: string
    isDestroyed: boolean
    mapTypes: string[]

    Map ClassNames Can be used to only apply this featureProvider to the specified maps

    name: string

    unique Name

    projection: Projection | undefined

    The feature response projection, if not present in the response format.

    properties: Record<string, unknown>
    style: StyleItem | undefined

    The style set on features created by this provider

    vectorProperties: VectorProperties

    The vector properties assigned to features created by this provider

    wfsGMLFormat: "GML2" | "GML3" | "GML32" | "GML" | undefined

    The GMLFormat used for the WfsLayer, defaults to GML2. Use 'GML', 'GML2', 'GML3' or 'GML32' as string