Interface ElevationProfile

An elevation profile sampled along a line.

interface ElevationProfile {
    gainMeters: number;
    line: readonly ElevationCoordinate[];
    lossMeters: number;
    maxElevationMeters: number;
    minElevationMeters: number;
    samples: readonly ElevationProfileSample[];
    totalDistanceMeters: number;
}

Properties

gainMeters line lossMeters maxElevationMeters minElevationMeters samples totalDistanceMeters

Properties

ReadonlygainMeters

gainMeters: number

Cumulative elevation gain across consecutive samples, in metres.

Readonlyline

line: readonly ElevationCoordinate[]

The line that was sampled (the input, verbatim).

ReadonlylossMeters

lossMeters: number

Cumulative elevation loss across consecutive samples, in metres.

ReadonlymaxElevationMeters

maxElevationMeters: number

Highest sampled elevation, in metres (0 when there are no samples).

ReadonlyminElevationMeters

minElevationMeters: number

Lowest sampled elevation, in metres (0 when there are no samples).

Readonlysamples

samples: readonly ElevationProfileSample[]

The sampled points, ordered from line start to end.

ReadonlytotalDistanceMeters

totalDistanceMeters: number

Total great-circle length of the line, in metres.

Settings

Member Visibility

On This Page

Properties