TomTom Maps for JavaScript
    Preparing search index...

    Type Alias AreaAnalyticsHeightConfig

    AreaAnalyticsHeightConfig:
        | {
            maxHeightMeters?: number;
            minHeightMeters?: number;
            scaleMode?: "predefinedRange"
            | "currentRange";
        }
        | { minHeightMeters?: number; scaleFactor?: number; scaleMode: "raw" }

    Height (extrusion) configuration for a metric.

    The shape depends on scaleMode:

    • 'predefinedRange' / 'currentRange' (default): use maxHeightMeters to set a true visual ceiling.
    • 'raw': use scaleFactor to multiply the raw metric value directly.

    Type Declaration

    • {
          maxHeightMeters?: number;
          minHeightMeters?: number;
          scaleMode?: "predefinedRange" | "currentRange";
      }
      • OptionalmaxHeightMeters?: number

        True visual maximum extrusion height in meters. The tallest cell reaches exactly this height.

        1000
        
      • OptionalminHeightMeters?: number

        Minimum extrusion height in meters.

        0
        
      • OptionalscaleMode?: "predefinedRange" | "currentRange"

        Normalised scale mode. The metric is mapped to a known range before computing height, so maxHeightMeters equals the actual maximum visual height in meters.

        'predefinedRange'
        
    • { minHeightMeters?: number; scaleFactor?: number; scaleMode: "raw" }
      • OptionalminHeightMeters?: number

        Minimum extrusion height in meters.

        0
        
      • OptionalscaleFactor?: number

        Multiplier applied to the raw metric value to obtain extrusion height in meters.

        1
        
      • scaleMode: "raw"

        Raw scale mode: scaleFactor is multiplied directly with the raw metric value.