@mathjax/src
    Preparing search index...

    The CHTML FontData class

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _styles: StyleJson

    Any styles needed for the font

    charUsage: Usage<[string, number]> = ...

    Data about the characters used (for adaptive CSS)

    cssFamilyPrefix: string

    A prefix to use for explicit font-family CSS settings

    cssFontMap: CssFontMap = {}

    The data to use to make variants to default fonts and css for unknown characters

    cssFontPrefix: string = ''

    The prefix to use for font names (e.g., 'TEX')

    The actual delimiter information for this font

    delimUsage: Usage<number> = ...

    Data about the delimiters used (for adpative CSS)

    fontUsage: StyleJson = {}

    New styles since last update

    newFonts: number = 0

    Number of new @font-face entries that have been processed

    options: OptionList

    The font options

    The actual font parameters for this font

    remapChars: RemapMapMap = {}

    The character maps

    sizeVariants: string[]

    The actual size variants to use for this font

    skewIcFactor: number = 0.75

    Factor by which to multiply italic correction for computation of delta in munderover

    stretchVariants: string[]

    The actual stretchy variants to use for this font

    The actual variant information for this font

    combiningChars: [number, number][] = ...

    The combining character ranges

    defaultAccentMap: RemapMap = ...

    The default remappings

    defaultChars: CharMapMap<CharOptions> = {}

    The default character data

    defaultCssFamilyPrefix: string = ''

    The default prefix for explicit font-family settings

    defaultCssFonts: CssFontMap = ...

    The family, style, and weight to use for each variant (for unknown characters) The 'unknown' family is replaced by options.unknownFamily

    defaultDelimiters: DelimiterMap<DelimiterData> = {}

    The default delimiter data

    defaultFonts: {} = {}

    The default @font-face declarations with %%URL%% where the font path should go

    defaultMnMap: RemapMap = ...

    Default map for characters inside

    defaultMoMap: RemapMap = ...

    Default map for characters inside

    defaultParams: FontParameters = ...

    The default font parameters for the font

    defaultSizeVariants: string[] = []

    The default variants for the fixed size stretchy delimiters

    defaultStretchVariants: string[] = []

    The default variants for the assembly parts for stretchy delimiters

    defaultStyles: {} = {}

    The CSS styles needed for this font.

    defaultVariantLetters: StringMap = {}

    The default font letter to use for each variant

    defaultVariants: string[][] = ...

    The standard variants to define

    dynamicExtensions: DynamicFontMap = ...

    The font extension dynamic data

    dynamicFiles: DynamicFileList = {}

    The dynamic file data

    JAX: string = 'CHTML'
    NAME: string = ''

    The name of the font that is being defined (used by extensions)

    OPTIONS: { dynamicPrefix: string; fontURL: string } = ...

    Default options

    SmpRanges: number[][] = ...

    Character ranges to remap into Math Alphanumerics

    SmpRemap: SmpMap = ...

    Characters to map back to other Unicode positions (holes in the Math Alphanumeric ranges)

    SmpRemapGreekL: SmpMap = ...

    Greek lower-case variants

    SmpRemapGreekU: SmpMap = ...

    Greek upper-case variants

    VariantSmp: { [name: string]: string | SmpData } = ...

    Variant locations in the Math Alphabnumerics block: [upper-alpha, lower-alpha, upper-Greek, lower-Greek, numbers]

    Accessors

    Methods

    • Parameters

      • styles: StyleJson

        The style object to add styles to

      • vletter: string

        The variant class letter (e.g., B, SS) where this character is being defined

      • n: number

        The unicode character being defined

      • data: ChtmlCharData

        The bounding box data and options for the character

      Returns void

    • Parameters

      • styles: StyleJson

        The style object to add styles to

      • c: string

        The vertical character whose part is being added

      • part: string

        The name of the part (beg, ext, end, mid) that is being added

      • n: number

        The unicode character to use for the part

      • v: string

        The variant for the character

      • HDW: ChtmlCharData

        The height-depth-width data for the stretchy character

      Returns number

      The width of the character

    • Parameters

      • styles: StyleJson

        The style object to add styles to

      • c: string

        The vertical character whose part is being added

      • part: string

        The name of the part (beg, ext, end, mid) that is being added

      • n: number

        The unicode character to use for the part

      • v: string

        The variant for the character

      • HDW: ChtmlCharData

        The height-depth-width data for the stretchy delimiter

      Returns number

      The total height of the character

    • Parameters

      • n: number

        A unicode code point to be converted to a selector for use with the CSS rules for fonts

      Returns string

      The character as a selector value.

    • Defines a character remapping map

      Parameters

      • name: string

        The name of the map to define or augment

      • remap: RemapMap

        The characters to remap

      Returns void

    • Parameters

      • n: number

        The number of ems

      Returns string

      The string representing the number with units of "em"

    • Parameters

      • n: number

        The number of ems (will be restricted to non-negative values)

      Returns string

      The string representing the number with units of "em"

    • Parameters

      • n: number

        The number of ems (will be restricted to non-negative values, with .1px rather than 0em)

      Returns string

      The string representing the number with units of "em"

    • Parameters

      • n: number

        The delimiter character number whose variant is needed

      • i: number

        The index in the size array of the size whose variant is needed

      Returns string

      The variant of the i-th size for delimiter n

    • Parameters

      • n: number

        The delimiter character number whose variant is needed

      • i: number

        The index in the stretch array of the part whose variant is needed

      Returns string

      The variant of the i-th part for delimiter n

    • Load the data for the character from the proper file, and do any associated setup that needs access to the FontData instance.

      Parameters

      Returns Promise<void>

      The promise that is resolved when the file is loaded

    • Parameters

      • data: ChtmlCharData

        The [h, d, w] data for the character

      • ic: number = 0

        The (optional) italic correction value

      Returns string

      The padding string for the h, d, w.

    • Parameters

      • styles: StyleJson

        The style object to add styles to

      • fonts: string[]

        The IDs for the fonts to add CSS for

      • root: string

        The root URL for the fonts (can be set by extensions)

      Returns void