Interface ElevationProvider

Represents an object that can provide elevations at given coordinates.

Note: to combine multiple providers into one, you can use the aggregateElevationProviders function.

interface ElevationProvider {
    getElevation(
        options: GetElevationOptions,
        result?: GetElevationResult,
    ): GetElevationResult;
    getElevationFast(x: number, y: number): ElevationSample | undefined;
}

Hierarchy (View Summary)

ElevationProvider
- MapLike

Implemented by

Map

Index

Methods

getElevation getElevationFast

Methods

getElevation

getElevation(
options: GetElevationOptions,
result?: GetElevationResult,
): GetElevationResult
Sample the elevation at the specified coordinate.

Note: sampling might return more than one sample for any given coordinate. You can sort them by core.ElevationSample.resolution | resolution to select the best sample for your needs.
Parameters
- options: GetElevationOptions
  The options.
- Optionalresult: GetElevationResult
  The result object to populate with the samples. If none is provided, a new empty result is created. The existing samples in the array are not removed. Useful to cumulate samples across different providers.
Returns GetElevationResult
The GetElevationResult containing the updated sample array.
- Defined in core/ElevationProvider.ts:34

getElevationFast

getElevationFast(x: number, y: number): ElevationSample | undefined
Returns the elevation at the specified coordinates, without any coordinate conversion.
Parameters
- x: number
  The X coordinate of the location to sample, in the same coordinate system as this elevation provider.
- y: number
  The Y coordinate of the location to sample, in the same coordinate system as this elevation provider.
Returns ElevationSample | undefined
- Defined in core/ElevationProvider.ts:22