react-map-gl-supercluster
Version:
> The easiest way to get `react-map-gl` and `supercluster` to work together
16 lines • 1.37 kB
TypeScript
import { a as ClusterFeature, c as PointFeatureProperties, i as Cluster, l as SuperclusterInstance, n as UseSuperclusterOptions$1, o as GeoJsonProperties, r as UseSuperclusterReturnValue, s as PointFeature, t as isCluster } from "./is-cluster-Dor1Q6AA.js";
import { MapRef } from "react-map-gl/mapbox";
//#region src/exports-mapbox.d.ts
/** Options for the Mapbox `useSupercluster` hook. */
type UseSuperclusterOptions<TFeatureProperties extends GeoJsonProperties, TClusterProperties extends GeoJsonProperties> = UseSuperclusterOptions$1<MapRef, TFeatureProperties, TClusterProperties>;
/**
* React hook that clusters points for the current Mapbox map viewport.
*
* @example
* ```tsx
* const { clusters, supercluster } = useSupercluster(points, { radius: 60 })
* ```
*/
declare const useSupercluster: <TFeatureProperties extends PointFeatureProperties, TClusterProperties extends GeoJsonProperties>(points: import("supercluster").PointFeature<TFeatureProperties>[], options?: UseSuperclusterOptions$1<MapRef, TFeatureProperties, TClusterProperties>) => UseSuperclusterReturnValue<TFeatureProperties, TClusterProperties>;
//#endregion
export { type Cluster, type ClusterFeature, type GeoJsonProperties, type PointFeature, type PointFeatureProperties, type SuperclusterInstance, UseSuperclusterOptions, type UseSuperclusterReturnValue, isCluster, useSupercluster };