Options
All
  • Public
  • Public/Protected
  • All
Menu

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

  • AbstractAlgorithm
    • SuperClusterAlgorithm

Index

Constructors

Properties

clusters: Cluster[]
markers: Marker[]
maxZoom: number
state: { zoom: number }

Type declaration

  • zoom: number
superCluster: Supercluster<AnyProps, AnyProps>

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, map})
    }
    }

    Parameters

    Returns Cluster[]

  • transformCluster(__namedParameters: ClusterFeature<{ marker: Marker }>): Cluster

Generated using TypeDoc