This is the documentation of version 0.62.2. Go to the latest version, 1.0.0.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ClusteringParams

    Tuneable parameters for runClustering. All optional with sensible defaults.

    type ClusteringParams = {
        eps?: number;
        maxClusters?: number;
        minMembers?: number;
        preFilter?: { excludeCategories?: string[]; minDelaySeconds?: number };
    }
    Index
    eps?: number

    DBSCAN neighbourhood radius in km. Default: 0.5

    maxClusters?: number

    Maximum clusters to return (top-N by total delay). Default: 6

    minMembers?: number

    Minimum members to form a cluster. Default: 3

    preFilter?: { excludeCategories?: string[]; minDelaySeconds?: number }

    Pre-filter rules applied before clustering.

    Type Declaration

    • OptionalexcludeCategories?: string[]

      Categories to exclude entirely. Default: ['roadworks', 'road-closed']

    • OptionalminDelaySeconds?: number

      Incidents with delayInSeconds below this are excluded (within excludeCategories). Default: 1 (i.e. exclude 0-delay)