TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ClusteringParams

    Tuneable parameters for clustering traffic incidents, through the clusterIncidents tool or the sandbox's cluster(incidents, params), 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 whose incidents are dropped when below minDelaySeconds. Default: ['roadworks', 'road-closed']

    • OptionalminDelaySeconds?: number

      Incidents in excludeCategories with delayInSeconds below this are excluded. Default: 1 (excludes 0-delay)