Class VectorClusterGroup

featureVisibility

• get featureVisibility(): FeatureVisibility

• Returns FeatureVisibility

globalHider

• get globalHider(): undefined | GlobalHider

• Returns undefined | GlobalHider

style

• get style(): VectorClusterStyleItem

• Returns VectorClusterStyleItem

styleFunction

• get styleFunction(): StyleFunction

• Returns StyleFunction

zIndex

• get zIndex(): number

• Returns number

StaticclassName

• get className(): string

• Returns string

constructor

• new VectorClusterGroup(options): VectorClusterGroup

• Parameters

  • options: VectorClusterGroupOptions

  Returns VectorClusterGroup

addLayer

• addLayer(layer): void

• Parameters

  • layer: VectorLayer

  Returns void

destroy

• destroy(): void

• Returns void

forceRedraw

• forceRedraw(): Promise<void>

• destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes

  Returns Promise<void>

getFeatures

• getFeatures(): Feature<Geometry>[]

• Returns Feature<Geometry>[]

getHighlightStyleForFeature

• getHighlightStyleForFeature(feature): void | StyleLike

• Parameters

  • feature: Feature<Geometry>

  Returns void | StyleLike

getImplementationForMap

• getImplementationForMap<T>(map): undefined | VectorClusterGroupImpl<T>

• creates or returns a cached array of cluster group implementations for the given map.

  Type Parameters

  • T extends VcsMap<VisualisationType>

  Parameters

  • map: T

    initialized Map

  Returns undefined | VectorClusterGroupImpl<T>

  return the specific implementation

getImplementationOptions

• getImplementationOptions(): VectorClusterGroupImplementationOptions

• Returns VectorClusterGroupImplementationOptions

getImplementations

• getImplementations(): VectorClusterGroupImpl<any>[]

• Returns all implementation of this vector cluster group for all maps

  Returns VectorClusterGroupImpl<any>[]

isSupported

• isSupported(map): boolean

• Parameters

  • map: VcsMap<VisualisationType>

  Returns boolean

mapActivated

• mapActivated(map): Promise<void>

• is called from the map when the map is activated and this vector cluster group belongs to the maps layer collections vector cluster group collection. Will create an implementation if it does not exists and will forward the activation call to the implementation.

  Parameters

  • map: VcsMap<VisualisationType>

  Returns Promise<void>

mapDeactivated

• mapDeactivated(map): void

• is called from the map when the map is deactivated, and this vector cluster group belongs to the maps layer collections vector cluster group collection. will forward deactivation call to the map specific implementation

  Parameters

  • map: VcsMap<VisualisationType>

  Returns void

removedFromMap

• removedFromMap(map): void

• is called when a vector cluster group is removed from a maps layer collections vector cluster group collection or said map is destroyed. destroys the associated implementation.

  Parameters

  • map: VcsMap<VisualisationType>

  Returns void

removeLayer

• removeLayer(layer): void

• Parameters

  • layer: VectorLayer

  Returns void

setGlobalHider

• setGlobalHider(globalHider?): void

• Parameters

  • OptionalglobalHider: GlobalHider

  Returns void

setStyle

• setStyle(style): void

• Parameters

  • style: VectorClusterStyleItem | VectorClusterStyleItemOptions

  Returns void

toJSON

• toJSON(): VectorClusterGroupOptions

• Returns VectorClusterGroupOptions

StaticgetDefaultOptions

• getDefaultOptions(): VectorClusterGroupOptions

• Returns VectorClusterGroupOptions

clusterDistance

highlightStyle

vectorProperties