Interface AbstractClusterSource.HasMinDistance

All Known Subinterfaces:
AbstractClusterSource.HasClusterSourceOptions
All Known Implementing Classes:
ClusterSource, NoOpClusterSource
Enclosing class:
AbstractClusterSource

public static interface AbstractClusterSource.HasMinDistance
Interface to be implemented by sources that should provide cluster minimum distance management.

For more details see: Cluster docs

  • Method Summary

    Modifier and Type
    Method
    Description
     
    void
    setMinDistance(Integer minDistance)
    Sets the minimum distance in pixels between clusters that will be capped at the configured distance.
  • Method Details

    • getMinDistance

      Integer getMinDistance()
      Returns:
      the minimum distance in pixels or null if not set
    • setMinDistance

      void setMinDistance(Integer minDistance)
      Sets the minimum distance in pixels between clusters that will be capped at the configured distance. By default, no minimum distance is guaranteed. This config can be used to avoid overlapping icons. As a tradeoff, the cluster feature's position will no longer be the center of all its features.

      For more details see: setMinDistance() docs

      Parameters:
      minDistance - minimum distance in pixels between clusters