TomTom Maps SDK for JavaScript
This is the documentation of version 1.0.0-rc.3. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias PlacesClusterSourceConfig

    How PlacesModule groups places into clusters, under the pin-clustered marker type.

    The fields are MapLibre's GeoJSON source cluster options without their cluster prefix.

    https://maplibre.org/maplibre-style-spec/sources/#cluster

    type PlacesClusterSourceConfig = {
        maxZoom?: number;
        minPoints?: number;
        properties?: Record<string, unknown>;
        radius?: number;
    }
    Index
    maxZoom? minPoints? properties? radius?
    maxZoom?: number

    Highest zoom that clusters places; past it every place is drawn on its own.

    17
    minPoints?: number

    Fewest places that form a cluster.

    2
    properties?: Record<string, unknown>

    Aggregators keyed by the cluster property they produce, landing on each cluster feature's properties for layer overrides to read with ['get', '<key>']. Each value is a [operator, mapExpression] pair (e.g. ['+', ['get', 'count']]) or the advanced [reduceExpression, mapExpression] form. The key clusterBaseMapIconIDs is reserved for the module's own.

    https://maplibre.org/maplibre-style-spec/sources/#cluster-properties

    radius?: number

    How near places merge into one cluster, in pixels.

    60

    Settings
    Member Visibility

    On This Page
    Properties