Class FeatureOverlay

constructor

• new FeatureOverlay(manager, index): FeatureOverlay

• Parameters

  • manager: FeatureOverlayMgr
  • index: number

  Returns FeatureOverlay

index_

listenerKeys_

manager_

addFeature

• addFeature(feature): void

• Add a feature to the feature overlay.

  Parameters

  • feature: Feature<Geometry>

    The feature to add.

  Returns void

clear

• clear(): void

• Remove all the features from the feature overlay.

  Returns void

handleFeatureAdd_

• handleFeatureAdd_(evt): void

• Parameters

  • evt: BaseEvent | Event

    Feature collection event.

  Returns void

handleFeatureRemove_

• handleFeatureRemove_(evt): void

• Parameters

  • evt: BaseEvent | Event

    Feature collection event.

  Returns void

isEmpty

• isEmpty(): boolean

• Check if featureOverlay has no features.

  Returns boolean

  True if there is no features. False otherwise.

removeFeature

• removeFeature(feature): void

• Remove a feature from the feature overlay.

  Parameters

  • feature: Feature<Geometry>

    The feature to remove.

  Returns void

setFeatures

• setFeatures(features): void

• 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

• setStyle(style): void

• Set a style for the feature overlay.

  Parameters

  • style: Style | Style[] | StyleFunction

    Style.

  Returns void