Interface ProfileOptions<T>

Type Parameters

  • T

Hierarchy

  • ProfileOptions

Properties

distanceExtractor formatter hoverCallback i18n outCallback poiExtractor scaleModifier

Properties

distanceExtractor

distanceExtractor: ((arg0: T) => number)

Type declaration

    • (arg0: T): number

    • Extract the distance from origin of a point (an item of the elevation data array).

      Parameters

      • arg0: T

      Returns number

formatter

formatter: ProfileFormatter

Formatter giving full control on how numbers are formatted.

hoverCallback

hoverCallback: ((arg0: Object, arg1: number, arg2: string, arg3: Object, arg4: string) => void)

Type declaration

    • (arg0: Object, arg1: number, arg2: string, arg3: Object, arg4: string): void

    • A callback called from the profile when the mouse moves over a point. The point, an item of the elevation data array, is passed as the first argument of the function.

      Parameters

      • arg0: Object
      • arg1: number
      • arg2: string
      • arg3: Object
      • arg4: string

      Returns void

i18n

i18n: I18n

outCallback

outCallback: (() => void)

Type declaration

    • (): void

    • A callback called from the profile when the mouse leaves the profile.

      Returns void

poiExtractor

poiExtractor: PoiExtractor

Extractor for parsing POI data.

scaleModifier

scaleModifier: ((arg0: Function, arg1: Function, arg2: number, arg3: number) => void)

Type declaration

    • (arg0: Function, arg1: Function, arg2: number, arg3: number): void

    • Allows to modify the raw x and y scales. Notably, it is possible to modify the y domain according to XY ratio rules, add padding or enforce y lower bound.

      Parameters

      • arg0: Function
      • arg1: Function
      • arg2: number
      • arg3: number

      Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc