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;
}

Index

Properties

gainMeters line lossMeters maxElevationMeters minElevationMeters samples totalDistanceMeters

Properties

`Readonly`gainMeters

gainMeters: number

Cumulative elevation gain across consecutive samples, in metres.

`Readonly`line

line: readonly ElevationCoordinate[]

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

`Readonly`lossMeters

lossMeters: number

Cumulative elevation loss across consecutive samples, in metres.

`Readonly`maxElevationMeters

maxElevationMeters: number

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

`Readonly`minElevationMeters

minElevationMeters: number

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

`Readonly`samples

samples: readonly ElevationProfileSample[]

The sampled points, ordered from line start to end.

`Readonly`totalDistanceMeters

totalDistanceMeters: number

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

Interface ElevationProfile

Index

Properties

Properties

`Readonly`gainMeters

`Readonly`line

`Readonly`lossMeters

`Readonly`maxElevationMeters

`Readonly`minElevationMeters

`Readonly`samples

`Readonly`totalDistanceMeters

Settings

On This Page

Interface ElevationProfile

Index

Properties

Properties

ReadonlygainMeters

Readonlyline

ReadonlylossMeters

ReadonlymaxElevationMeters

ReadonlyminElevationMeters

Readonlysamples

ReadonlytotalDistanceMeters

Settings

On This Page

`Readonly`gainMeters

`Readonly`line

`Readonly`lossMeters

`Readonly`maxElevationMeters

`Readonly`minElevationMeters

`Readonly`samples

`Readonly`totalDistanceMeters