@maplibre/geojson-vt
    Preparing search index...

    Type Alias SuperclusterOptions

    type SuperclusterOptions = {
        coordinates?: GeoJSONVTCoordinatesType;
        extent?: number;
        generateId?: boolean;
        log?: boolean;
        map?: (props: GeoJSON.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;
        wrap?: boolean;
    }
    Index
    coordinates? extent? generateId? log? map? maxZoom? minPoints? minZoom? nodeSize? radius? reduce? wrap?
    coordinates?: GeoJSONVTCoordinatesType

    The space the points are in, see coordinates in GeoJSONVTOptions. The bounding box of getClusters is in the same space.

    'lngLat'
    extent?: number

    Tile extent (radius is calculated relative to it)

    512
    generateId?: boolean

    Whether to generate numeric ids for input features (in vector tiles). Each position of a MultiPoint feature gets an id of its own.

    false
    log?: boolean

    Whether to log timing info

    false
    map?: (props: GeoJSON.GeoJsonProperties) => Record<string, unknown>

    Properties to use for individual points when running the reducer

    props => props
    maxZoom?: number

    Max zoom level to cluster the points on. A value above 30 is limited to 30.

    16
    minPoints?: number

    Minimum points to form a cluster

    2
    minZoom?: number

    Min zoom to generate clusters on. A value above 30 is limited to 30.

    0
    nodeSize?: number

    Size of the KD-tree leaf node, affects performance

    64
    radius?: number

    Cluster radius in pixels

    40
    reduce?:
        | (
            (
                accumulated: Record<string, unknown>,
                props: Record<string, unknown>,
            ) => void
        )
        | null

    A reduce function for calculating custom cluster properties

    null
    wrap?: boolean

    Whether the world wraps around the antimeridian, see wrap in GeoJSONVTOptions. With false, points outside the square are left out of the clusters, the tiles at an edge get no points from the opposite one, and getTile returns null outside the square.

    true

    Settings
    Member Visibility

    On This Page
    Properties