On this page
Type Alias SuperclusterOptions
type SuperclusterOptions = {
extent?: number;
generateId?: boolean;
log?: boolean;
map?: (props: GeoJsonProperties) => Record<string, unknown>;
maxZoom?: number;
minPoints?: number;
minZoom?: number;
nodeSize?: number;
radius?: number;
reduce?:
| (
(
accumulated: Record<string, unknown>,
props: Record<string, unknown>,
) => void
)
| null;
}
extent?: number;
generateId?: boolean;
log?: boolean;
map?: (props: GeoJsonProperties) => Record<string, unknown>;
maxZoom?: number;
minPoints?: number;
minZoom?: number;
nodeSize?: number;
radius?: number;
reduce?:
| (
(
accumulated: Record<string, unknown>,
props: Record<string, unknown>,
) => void
)
| null;
}
Index
Properties
Properties
Optionalextent
extent?: number
OptionalgenerateId
generateId?: boolean
Whether to generate numeric ids for input features (in vector tiles)
Optionallog
log?: boolean
Whether to log timing info
Optionalmap
Properties to use for individual points when running the reducer
OptionalmaxZoom
maxZoom?: number
Max zoom level to cluster the points on
OptionalminPoints
minPoints?: number
Minimum points to form a cluster
OptionalminZoom
minZoom?: number
Min zoom to generate clusters on
OptionalnodeSize
nodeSize?: number
Size of the KD-tree leaf node, affects performance
Optionalradius
radius?: number
Cluster radius in pixels
Optionalreduce
reduce?:
| (
(
accumulated: Record<string, unknown>,
props: Record<string, unknown>,
) => void
)
| null
| (
(
accumulated: Record<string, unknown>,
props: Record<string, unknown>,
) => void
)
| null
A reduce function for calculating custom cluster properties
Was this helpful?
Tile extent (radius is calculated relative to it)