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

    Type Alias AreaAnalyticsHeightConfig

    AreaAnalyticsHeightConfig:
        | {
            maxMeters?: number;
            minMeters?: number;
            scaleMode?: Exclude<AreaAnalyticsScaleMode, "raw">;
        }
        | { metersPerUnit?: number; minMeters?: number; scaleMode: "raw" }

    Height (extrusion) configuration for a metric.

    The shape depends on scaleMode:

    • 'predefinedRange' / 'currentRange': use maxMeters to set a true visual ceiling.
    • 'raw': use metersPerUnit to turn the raw metric value into metres of height.

    On speed, where higher is better, cells rise as speed drops, in every scale mode.

    Type Declaration

    • {
          maxMeters?: number;
          minMeters?: number;
          scaleMode?: Exclude<AreaAnalyticsScaleMode, "raw">;
      }
      • OptionalmaxMeters?: number

        True visual maximum extrusion height in meters. A cell at the top of the range reaches this height, and none rises above it.

        1000
        
      • OptionalminMeters?: number

        Minimum extrusion height in meters.

        0
        
      • OptionalscaleMode?: Exclude<AreaAnalyticsScaleMode, "raw">

        Normalised scale mode. The metric is mapped to a known range before computing height, so a cell at the top of the range reaches maxMeters.

        'predefinedRange', and 'currentRange' for networkLength

    • { metersPerUnit?: number; minMeters?: number; scaleMode: "raw" }
      • OptionalmetersPerUnit?: number

        Metres of extrusion height per unit of the metric.

        1
        
      • OptionalminMeters?: number

        Minimum extrusion height in meters.

        0
        
      • scaleMode: "raw"

        Raw scale mode. The height is the raw metric value times metersPerUnit. On speed, it is the drop below 120 km/h times metersPerUnit.