interface ProfileOptions<T> {
    distanceExtractor: ((arg0) => number);
    formatter: ProfileFormatter;
    hoverCallback: ((arg0, arg1, arg2, arg3, arg4) => void);
    i18n: I18n;
    outCallback: (() => void);
    poiExtractor: PoiExtractor;
    scaleModifier: ((arg0, arg1, arg2, arg3) => void);
}

Type Parameters

  • T

Properties

distanceExtractor: ((arg0) => number)

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

Type declaration

    • (arg0): number
    • Parameters

      • arg0: T

      Returns number

formatter: ProfileFormatter

Formatter giving full control on how numbers are formatted.

hoverCallback: ((arg0, arg1, arg2, arg3, arg4) => 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.

Type declaration

    • (arg0, arg1, arg2, arg3, arg4): void
    • Parameters

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

        Returns void

    i18n: I18n
    outCallback: (() => void)

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

    Type declaration

      • (): void
      • Returns void

    poiExtractor: PoiExtractor

    Extractor for parsing POI data.

    scaleModifier: ((arg0, arg1, arg2, arg3) => 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.

    Type declaration

      • (arg0, arg1, arg2, arg3): void
      • Parameters

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

        Returns void

    Generated using TypeDoc