Class FeatureOverlay

Provides a featureOverlay used by the FeatureOverlayManager.

Example of initialization: const featureOverlay = new FeatureOverlay(manager, index);

Param

The feature overlay manager.

Param

This feature overlay's index.

Hierarchy

  • FeatureOverlay

Constructors

constructor

Properties

index_ listenerKeys_ manager_

Methods

addFeature clear handleFeatureAdd_ handleFeatureRemove_ isEmpty removeFeature setFeatures setStyle

Constructors

constructor

Properties

index_

index_: number

listenerKeys_

listenerKeys_: EventsKey[]

manager_

manager_: FeatureOverlayMgr

Methods

addFeature

  • Add a feature to the feature overlay.

    Parameters

    • feature: Feature<Geometry>

      The feature to add.

    Returns void

clear

handleFeatureAdd_

  • handleFeatureAdd_(evt: Event | BaseEvent): void

  • Parameters

    • evt: Event | BaseEvent

      Feature collection event.

    Returns void

handleFeatureRemove_

  • handleFeatureRemove_(evt: Event | BaseEvent): void

  • Parameters

    • evt: Event | BaseEvent

      Feature collection event.

    Returns void

isEmpty

  • Check if featureOverlay has no features.

    Returns

    True if there is no features. False otherwise.

    Returns boolean

removeFeature

  • Remove a feature from the feature overlay.

    Parameters

    • feature: Feature<Geometry>

      The feature to remove.

    Returns void

setFeatures

  • Configure this feature overlay with a feature collection. Features added to the collection are also added to the overlay. Same for removal. If you configure the feature overlay with a feature collection you will use the collection to add and remove features instead of using the overlay's addFeature, removeFeature and clear functions.

    Parameters

    • features: Collection<Feature<Geometry>>

      Feature collection.

    Returns void

setStyle

  • Set a style for the feature overlay.

    Parameters

    • style: Style | Style[] | StyleFunction

      Style.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc