Type alias FormattingFunction

Type declaration

• • (value: number, range: FormattingRange, locale?: string, shiftInfo?: {
        shiftOrigin: number;
        utc: boolean;
        valueShifted: number;
    }): string

  • Type definition for a pure formatting function.

    The formatter is supplied a numeric value, and it formats it into a string, that can be displayed on an Axis tick, for example.

    Returns

    Value formated as string

    Parameters

    • value: number

      Numeric value.

    • range: FormattingRange

      Object that represents the possible range for value. For example, the start-end range of an Axis.

    • Optional locale: string

    • Optional shiftInfo: {
          shiftOrigin: number;
          utc: boolean;
          valueShifted: number;
      }

      • shiftOrigin: number

      • utc: boolean

      • valueShifted: number

    Returns string