Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected clusters

clusters: Cluster[] = []

Protected gridSize

gridSize: number

Protected maxDistance

maxDistance: number

Protected maxZoom

maxZoom: number

Protected viewportPadding

viewportPadding: number = 60

Methods

Protected addToClosestCluster

  • addToClosestCluster(marker: Marker, map: Map, projection: MapCanvasProjection): void

  • 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[]

Generated using TypeDoc