Interface SurfaceSampleable

sampleSurfaceHeights

• sampleSurfaceHeights(
      points: readonly { lat: number; lng: number }[],
      opts?: SurfaceSampleOptions,
  ): (number | null)[]

  Sample the height of the topmost rendered surface at each position.

  Parameters

  • points: readonly { lat: number; lng: number }[]

    lng/lat in degrees.

  • Optionalopts: SurfaceSampleOptions

    Optional sampling options (SurfaceSampleOptions.gridPx tunes the overhead pass resolution).

  Returns (number | null)[]

  Height in metres above the rendered ground datum per point, or null where the layer has no surface (or the tile isn't resident).