Class Supercluster

constructor

• new Supercluster(options?: SuperclusterOptions): Supercluster

  Parameters

  • Optionaloptions: SuperclusterOptions

  Returns Supercluster

clusterProps

options

points

stride

trees

getChildren

• getChildren(clusterId: number): ClusterOrPointFeature[]

  Returns the immediate children (clusters or points) of a cluster as GeoJSON.

  Parameters

  • clusterId: number

    The target cluster id.

  Returns ClusterOrPointFeature[]

getClusterExpansionZoom

• getClusterExpansionZoom(clusterId: number): number

  Returns the zoom level at which a cluster expands into multiple children.

  Parameters

  • clusterId: number

    The target cluster id.

  Returns number

getClusters

• getClusters(
      bbox: [number, number, number, number],
      zoom: number,
  ): ClusterOrPointFeature[]

  Returns clusters and/or points within a bounding box at a given zoom level.

  Parameters

  • bbox: [number, number, number, number]

    Bounding box in [westLng, southLat, eastLng, northLat] order.

  • zoom: number

    Zoom level to query.

  Returns ClusterOrPointFeature[]

getLeaves

• getLeaves(
      clusterId: number,
      limit?: number,
      offset?: number,
  ): Feature<Point, { [name: string]: any }>[]

  Returns leaf point features under a cluster, paginated by limit and offset.

  Parameters

  • clusterId: number

    The target cluster id.

  • Optionallimit: number

    Maximum number of points to return (defaults to 10).

  • Optionaloffset: number

    Number of points to skip before collecting results (defaults to 0).

  Returns Feature<Point, { [name: string]: any }>[]

getTile

• getTile(z: number, x: number, y: number): GeoJSONVTTile

  Generates a vector-tile-like representation of a single tile.

  Parameters

  • z: number

    Tile zoom.

  • x: number

    Tile x coordinate.

  • y: number

    Tile y coordinate.

  Returns GeoJSONVTTile

initialize

• initialize(features: GeoJSONVTInternalFeature[]): void
  Internal

  Loads internal GeoJSONVT point features from a data source and builds the clustering index.

  Parameters

  • features: GeoJSONVTInternalFeature[]

    GeoJSONVTInternalFeature data source features to filter and cluster.

  Returns void

load

• load(points: Feature<Point, { [name: string]: any }>[]): void

  Loads GeoJSON point features and builds the internal clustering index.

  Parameters

  • points: Feature<Point, { [name: string]: any }>[]

    GeoJSON point features to cluster.

  Returns void

updateIndex

• updateIndex(
      features: GeoJSONVTInternalFeature[],
      _affected: GeoJSONVTInternalFeature[],
      options: GeoJSONVTOptions,
  ): void
  Internal

  Updates the cluster data by rebuilding.

  Parameters

  • features: GeoJSONVTInternalFeature[]
  • _affected: GeoJSONVTInternalFeature[]
  • options: GeoJSONVTOptions

  Returns void