npm.nicfv.com
    Preparing search index...

    Variable configConst

    config: {
        convertToText: boolean;
        decimalsShown: number;
        multiplySymbol: string;
        scalarSymbol: string;
        scientificNotationMagnitude: { max: number; min: number };
        showUnitless: boolean;
        unitDelimiters: { left: string; right: string };
    } = ...

    Global configuration options for the dimensional package

    Type Declaration

    • convertToText: boolean

      Automatically convert dimension, unit, and prefix names to LaTeX text elements
      Default: true

    • decimalsShown: number

      The number of decimals displayed when converting quantities to strings
      Default: 3

    • multiplySymbol: string

      The LaTeX symbol for combined units or dimensions by multiplication
      Default: \cdot

    • scalarSymbol: string

      The symbol to use for dimensionless and unitless quantities
      Default: 1

    • scientificNotationMagnitude: { max: number; min: number }

      The base-10 magnitude bounds at which numeric values are displayed in scientific notation

      • max: number

        The maximum magnitude for standard notation
        Default: 6 (1,000,000)

      • min: number

        The minimum magnitude for standard notation
        Default: -6 (0.000 001)

    • showUnitless: boolean

      Always display the unit on a quantity, even for unitless quantities.
      Default: true

    • unitDelimiters: { left: string; right: string }

      Characters in LaTeX that mark the beginning and end of a unit within a quantity

      • left: string

        The left side
        Default: \left[

      • right: string

        The right side
        Default: \right]