@magiclane/maps-sdk
    Preparing search index...

    Class BuildTerrainProfile

    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 Route.terrainProfile to be populated in the route response.

    Index

    Constructors

    • Creates preferences for terrain profile building.

      Parameters

      • Optionaloptions: { enable?: boolean; minVariation?: number }

        Configuration options

        • Optionalenable?: boolean

          Enable/disable terrain profile build. Default is false

        • OptionalminVariation?: 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

      Returns BuildTerrainProfile

    Properties

    enable: boolean

    Enable/disable terrain profile build.

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

    Default is false

    minVariation: 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

    • Get hash code for use in maps/sets

      Returns number

    • Internal

      Serializes this instance to a JSON-compatible map.

      Used internally, not intended for direct use by consumers. The map structure may change without notice.

      Returns Record<string, any>

      JSON-compatible map

    • Internal

      Creates an instance from a JSON-compatible map.

      Used internally, not intended for direct use by consumers. The map structure may change without notice.

      Parameters

      • json: any

        JSON-compatible map

      Returns BuildTerrainProfile

      A new BuildTerrainProfile instance