@mathjax/src
    Preparing search index...

    Class SpeechRegion

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

    Index

    Constructors

    constructor

    Properties

    active CLASS div document highlighter inner node className style styleAdded

    Methods

    AddElement AddStyles Clear Hide highlight makeUtterances position Show stackRegions Update

    Constructors

    Properties

    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: A11yDocument

    The document the live region is added to.

    highlighter: Highlighter = ...

    The highlighter to use.

    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 = ...
    styleAdded: boolean = false

    True if the style has already been added to the document.

    Methods

    • Parameters

      • highlighter: Highlighter

      Returns void

    • Generates the utterance chain.

      Parameters

      • ssml: SsmlElement[]

        The list of ssml annotations.

      • locale: string

        The locale to use.

      Returns void

    • Parameters

      • node: HTMLElement
      • highlighter: Highlighter

      Returns void

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

      Parameters

      • node: HTMLElement

        The reference node.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods