@mathjax/src
    Preparing search index...

    Class FindTeX<N, T, D>

    Type Parameters

    • N

      The HTMLElement node class

    • T

      The Text node class

    • D

      The Document class

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    end: { [name: string]: EndItem }

    The end-delimiter data keyed to the opening delimiter string

    env: number

    The index of the \begin...\end pattern in the regex match array

    hasPatterns: boolean

    False if the configuration has no delimiters (so search can be skipped), true otherwise

    options: OptionList

    The actual options for this instance

    start: RegExp

    The regular expression for any starting delimiter

    sub: number

    The index of the \ref and escaped character patters in the regex match array

    OPTIONS: OptionList = ...

    Methods

    • Add the needed patterns for a pair of delimiters

      Parameters

      • starts: string[]

        Array of starting delimiter strings

      • delims: Delims

        Array of delimiter strings, as [start, end]

      • display: boolean

        True if the delimiters are for display mode

      Returns void

    • Create the pattern for a close delimiter

      Parameters

      • end: string

        The end delimiter text

      • Optionalendp: string

        The end delimiter pattern (overrides the literal end pattern)

      Returns RegExp

      The regular expression for the end delimiter

    • Search for the end delimiter given the start delimiter, skipping braced groups, and control sequences that aren't the close delimiter.

      Parameters

      • text: string

        The string being searched for the end delimiter

      • n: number

        The index of the string being searched

      • start: RegExpExecArray

        The result array from the start-delimiter search

      • end: EndItem

        The end-delimiter data corresponding to the start delimiter

      Returns ProtoItem<N, T>

      The proto math item for the math, if found

    • Search a string for math delimited by one of the delimiter pairs, or by \begin{env}...\end{env}, or \eqref{...}, \ref{...}, \, or $.

      Parameters

      • math: ProtoItem<N, T>[]

        The array of proto math items located so far

      • n: number

        The index of the string being searched

      • text: string

        The string being searched

      Returns void

    • Create the patterns needed for searching the strings for TeX based on the configuration options

      Returns void