@vcmap/core
    Preparing search index...

    Class CompositeFeatureProvider

    A feature provider that combines multiple feature providers and attribute providers. Used to combine multiple feature & attribute providers for a layer. The order of providers is important, as attributes are applied and features are returned in the order.

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    • get className(): string

      Returns string

    Constructors

    Methods

    • 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: [number, number]

        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
    isDestroyed: boolean
    mapTypes: string[]

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

    name: string

    unique Name

    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