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

    Type Alias AreaAnalyticsFeatureProperties

    Properties attached to each region feature in an area analytics result.

    type AreaAnalyticsFeatureProperties = {
        anomalies?: Partial<
            Record<AreaAnalyticsMetricKey, AreaAnalyticsAnomaly[]>,
        >;
        baseData: AreaAnalyticsMetrics;
        level: number;
        name?: string;
        tiledData?: { tiles: AreaAnalyticsTileEntry[] };
        timedData: AreaAnalyticsTimedData;
        timezone?: string;
    }
    Index
    anomalies? baseData level name? tiledData? timedData timezone?
    anomalies?: Partial<Record<AreaAnalyticsMetricKey, AreaAnalyticsAnomaly[]>>

    Detected anomalies, keyed by metric. They are empty for trafficAreaAnalytics, as the service detects anomalies only over 35 days or more, beyond a request's 31-day limit.

    baseData: AreaAnalyticsMetrics

    Overall aggregated traffic metrics for the full analysis period.

    level: number

    Hierarchical level of the region in the analysis.

    name?: string

    Name of the analysis region, which the API echoes from a request that names one. The SDK names none, so it is absent.

    tiledData?: { tiles: AreaAnalyticsTileEntry[] }

    Per-tile traffic metrics for the region, if heatmap data was requested.

    timedData: AreaAnalyticsTimedData

    Traffic metrics broken down by time granularity.

    timezone?: string

    IANA timezone the API echoes from a request that names one. The SDK names none, so it is absent.

    Settings
    Member Visibility

    On This Page
    Properties