@mathjax/src
    Preparing search index...

    Class SpeechRegion

    Region class that enables auto voicing of content via SSML markup.

    Index
    constructor
    active CLASS div document highlighter inner node className style
    sheetId styleSheet
    AddElement AddStyles cancelVoice Clear Hide makeUtterances position Show stackRegions Update setColor
    active: boolean = false

    Flag to activate auto voicing.

    CLASS: typeof AbstractRegion

    The actual class name to refer to static elements of a class.

    div: HTMLElement

    The outer div node.

    document: ExplorerMathDocument

    The document the live region is added to.

    highlighter: Highlighter

    The highlighter to use. (Set by ExplorerPool)

    inner: HTMLElement

    The inner node.

    node: Element = null

    The math expression that is currently explored. Other regions do not need this node as the explorer administers both node and region, while only pushing output into the region. But in the case autovoicing the speech regions needs to mark elements in the node directly.

    className: string = 'MJX_LiveRegion'
    style: StyleJsonSheet = null
    • get styleSheet(): HTMLStyleElement

      Returns HTMLStyleElement

      The stylesheet for this region

    • Generates the utterance chain.

      Parameters

      • ssml: SsmlElement[]

        The list of ssml annotations.

      • locale: string

        The locale to use.

      Returns void

    • Parameters

      • node: HTMLElement

      Returns void

    • Auxiliary position method that stacks shown regions of the same type.

      Parameters

      • node: HTMLElement

        The reference node.

      Returns void

    • Set the CSS styles for a given color type and priority

      Parameters

      • type: string

        The color type (fg or bg)

      • priority: number

        1 = primary, 2 = secondary

      • color: string

        The color name (blue, red, black, etc.)

      • opacity: number

        The alpha channel for the color

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods