Class GridAlgorithm

The default Grid algorithm historically used in Google Maps marker clustering.

The Grid algorithm does not implement caching and markers may flash as the viewport changes. Instead use SuperClusterAlgorithm.

Hierarchy

  • AbstractViewportAlgorithm
    • GridAlgorithm

Constructors

constructor

Properties

clusters gridSize maxDistance maxZoom state viewportPadding

Methods

addToClosestCluster calculate cluster noop

Constructors

constructor

Properties

Protected clusters

clusters: Cluster[] = []

Protected gridSize

gridSize: number

Protected maxDistance

maxDistance: number

Protected maxZoom

maxZoom: number

Protected state

state: {
    zoom: number;
}

Type declaration

  • zoom: number

Protected viewportPadding

viewportPadding: number = 60

Methods

Protected addToClosestCluster

  • Parameters

    • marker: Marker
    • map: Map
    • projection: MapCanvasProjection

    Returns void

calculate

Protected cluster

Protected noop

  • Helper function to bypass clustering based upon some map state such as zoom, number of markers, etc.

     cluster({markers, map}: AlgorithmInput): Cluster[] {
       if (shouldBypassClustering(map)) {
         return this.noop({markers, map})
       }
    }

    Parameters

    Returns Cluster[]

Settings

Member Visibility

Theme

Generated using TypeDoc