A very fast JavaScript algorithm for geospatial point clustering using KD trees.

See

https://www.npmjs.com/package/supercluster for more information on options.

Hierarchy

  • AbstractViewportAlgorithm
    • SuperClusterViewportAlgorithm

Constructors

Properties

clusters: Cluster[]
markers: Marker[]
maxZoom: number
superCluster: Supercluster<AnyProps, AnyProps>
viewportPadding: number = 60

Methods

  • 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})
    }
    }

    Type Parameters

    Parameters

    • __namedParameters: T

    Returns Cluster[]

Generated using TypeDoc