BuildTerrainProfile - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > BuildTerrainProfile

BuildTerrainProfile class

Preferences regarding building terrain profile.

These preferences influence whether terrain profile data is calculated. Terrain profile data includes elevation changes along the route, which can be useful for activities like biking or hiking.

These settings are required for the to be populated in the route response.

Routing

Signature:

export declare class BuildTerrainProfile

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Creates preferences for terrain profile building.

Properties

Property	Modifiers	Type	Description
enable	`readonly`	boolean	Enable/disable terrain profile build. The terrain profile will be built only if this is set to true. Default is `false`
minVariation	`readonly`	number	The minimum elevation variation to be registered for total up/total down statistics. A value < 0 lets the SDK choose a proper value. Default is `-1`

Property

Modifiers

Type

Description

enable

readonly

boolean

Enable/disable terrain profile build.

The terrain profile will be built only if this is set to true.

Default is false

minVariation

readonly

number

The minimum elevation variation to be registered for total up/total down statistics.

A value < 0 lets the SDK choose a proper value. Default is -1

Methods

Method	Modifiers	Description
equals(other)		Check equality with another BuildTerrainProfile
hashCode()		Get hash code for use in maps/sets