Variable FormattingFunctionsConst

FormattingFunctions: {
    LogarithmicExponents: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string);
    LogarithmicExponentsRounded: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string);
    LogarithmicExtreme: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string);
    LogarithmicNoExponents: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string);
    Numeric: ((value: number, range: FormattingRange) => string);
    NumericUnits: ((value: number, range: FormattingRange) => string);
    Scientific: ((value: number, range: FormattingRange) => string);
} = ...

Enum-like object for implementations of default Formatting functions.

Type declaration

  • LogarithmicExponents: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string)
      • (value: number, range: FormattingRange, locale?: string, logBase?: number | "e"): string

      • Formats number like "2×10¹⁰"

        Alternate, built-in formatting for logarithmic ticks. Better suited especially for applications with zooming.

         // Example, enable extreme ticks with exponent formatting
         chart
             .getDefaultAxisX()
             .setTickStrategy(AxisTickStrategies.Numeric, (ticks) =>
                 ticks
                     .setMajorFormattingFunction(FormattingFunctions.LogarithmicExponentsRounded)
                     .setMinorFormattingFunction(FormattingFunctions.LogarithmicExponents)
             )

        Parameters

        • value: number
        • range: FormattingRange
        • Optional locale: string
        • logBase: number | "e" = 10

        Returns string

  • LogarithmicExponentsRounded: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string)
      • (value: number, range: FormattingRange, locale?: string, logBase?: number | "e"): string

      • Formats number like "10¹⁰"

        Alternate, built-in formatting for logarithmic ticks. Better suited especially for applications with zooming.

         // Example, enable extreme ticks with exponent formatting
         chart
             .getDefaultAxisX()
             .setTickStrategy(AxisTickStrategies.Numeric, (ticks) =>
                 ticks
                     .setMajorFormattingFunction(FormattingFunctions.LogarithmicExponentsRounded)
                     .setMinorFormattingFunction(FormattingFunctions.LogarithmicExponents)
             )

        Parameters

        • value: number
        • range: FormattingRange
        • Optional locale: string
        • logBase: number | "e" = 10

        Returns string

  • LogarithmicExtreme: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string)
      • (value: number, range: FormattingRange, locale?: string, logBase?: number | "e"): string
      • Beta

        Formats number like "2.13×10¹⁰"

        Recommended to be used together with "extreme ticks" when logarithmic ticks are paired with requirement of zooming far in.

         // Example, enable extreme ticks with special formatting
         chart
             .getDefaultAxisX()
             .setTickStrategy(AxisTickStrategies.Numeric, (ticks) =>
                 ticks
                     .setExtremeTickStyle(chart.getTheme().xAxisNumericTicks.majorTickStyle)
                     .setExtremeFormattingFunction(FormattingFunctions.LogarithmicExtreme),
             )

        Parameters

        • value: number
        • range: FormattingRange
        • Optional locale: string
        • logBase: number | "e" = 10

        Returns string

  • LogarithmicNoExponents: ((value: number, range: FormattingRange, locale?: string, logBase?: number | "e") => string)
      • (value: number, range: FormattingRange, locale?: string, logBase?: number | "e"): string
      • Beta

        Default formatting function for logarithmic axis. Formats values like "0.1", "1", "10" and so on.

        Parameters

        • value: number
        • range: FormattingRange
        • Optional locale: string
        • logBase: number | "e" = 10

        Returns string

  • Numeric: ((value: number, range: FormattingRange) => string)
      • (value: number, range: FormattingRange): string

      • Formats a number.

        Returns

        Value formatted as string

        Parameters

        • value: number

          Value on range to format

        • range: FormattingRange

          FormattingRange

        Returns string

  • NumericUnits: ((value: number, range: FormattingRange) => string)
      • (value: number, range: FormattingRange): string

      • Formats a number by range-dependant rounding and usage of units.

        Returns

        Value formate as string with units

        Parameters

        • value: number

          Value on range to format

        • range: FormattingRange

          FormattingRange

        Returns string

  • Scientific: ((value: number, range: FormattingRange) => string)
      • (value: number, range: FormattingRange): string
      • Beta

        Formats number in scientific notation. For example, 1000 -> 1.00e+3

         // Example of formatting to scientific notation
         chart
             .getDefaultAxisX()
             .setTickStrategy(AxisTickStrategies.Numeric, (strategy) =>
                 strategy
                     .setFormattingFunction(FormattingFunctions.Scientific),
             )

        Returns

        Value formatted as string

        Released as beta feature in v6.0.0. This feature may still change according to user feedback and experiences

        Parameters

        • value: number

          Value on range to format

        • range: FormattingRange

          FormattingRange

        Returns string

Settings

Member Visibility

Theme