@mathjax/src
    Preparing search index...

    The type that is consumed by the Region of this explorer.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    attached: boolean = false

    True when explorer is attached to a node

    brailleRegion: LiveRegion

    The braille region.

    cellTypes: string[] = ...

    The possible types for a "table" cell

    clicked: HTMLElement = null

    The clicked node from a mousedown event

    current: HTMLElement = null

    The currently focused element.

    currentMark: number = -1

    The index of the current position in the array.

    The accessible math document.

    events: [string, (x: Event) => void][] = ...
    focusSpeech: boolean = false

    True when we are refocusing on the speech node

    img: HTMLElement = null

    The speech node when the top-level node has no role

    The math item.

    lastMark: HTMLElement = null

    The last explored position from previously exploring this expression.

    magnifyRegion: HoverRegion

    The magnification region.

    marks: HTMLElement[] = []

    The array of saved positions.

    node: HTMLElement

    The node the explorer is assigned to.

    pendingIndex: number[] = []

    First index of cell to jump to

    The explorer pool.

    refocus: HTMLElement = null

    Node to focus on when restarted

    region: SpeechRegion

    The speech region for the explorer.

    restarted: string = null

    Selector string for re-focusing after re-rendering

    sound: boolean = false

    Switches on or off the use of sound on this explorer.

    speech: HTMLElement = null

    The transient speech node

    speechType: string = ''

    Set to 'd' when depth is showing, 'x' when summary, '' when speech.

    stoppable: boolean = true

    Accessors

    • get highlighter(): Highlighter

      Returns Highlighter

      The Sre highlighter associated with the walker.

    Methods

    • Remove the top-level speech node and create a temporary one for the given node.

      Parameters

      • node: HTMLElement

        The node to be spoken

      • describe: boolean

        True if the description should be added

      Returns void

    • Parameters

      • table: HTMLElement

        An HTML node for a semantic table element

      • i: number

        The row number of the desired cell in the table

      • j: number

        The column numnber of the desired cell in the table

      Returns HTMLElement

      The HTML element for the (i,j)-th cell of the table

    • Parameters

      • cell: HTMLElement

        The HTML node for a semantic table cell

      Returns [number, number]

      The row and column numbers for the cell in its table (0-based)

    • Parameters

      • cell: HTMLElement

        An HTML node that is a cell of a table

      Returns HTMLElement

      The HTML node for semantic table element containing the cell

    • Parameters

      • node: HTMLElement

        The node whose child array we want

      Returns string[]

      The array of semantic IDs of its children

    • Handle a double-click event (focus full expression)

      Parameters

      • event: MouseEvent

        The mouse click event

      Returns void

    • Process Enter key events

      Parameters

      • event: KeyboardEvent

        The event for the enter key

      Returns boolean | void

      False means play the honk sound

    • Find the speech node that was clicked, if any

      Parameters

      • node: HTMLElement

        The target node that was clicked

      • x: number

        The x-coordinate of the click

      • y: number

        The y-coordinate of the click

      Returns HTMLElement

      The clicked node or null

    • Determine the node that should be made active when we start (the refocus, current, or restarted node, if any otherwise null)

      Returns HTMLElement

      The node to be made the current node

    • Get an element's first speech child. This is computed by going through the owns list until the first speech element is found.

      Parameters

      • node: HTMLElement

        The parent element to get a child from

      Returns HTMLElement

      The first speech child of the node

    • Parameters

      • id: string

        The semantic ID of the node we want

      Returns HTMLElement

      The HTML node with that id

    • Parameters

      • node: HTMLElement

        The HTML node whose parent is to be found

      Returns HTMLElement

      The HTML node of the parent node

    • Get all nodes with the same semantic id (multiple nodes if there are line breaks).

      Parameters

      • node: HTMLElement

        The node to check if it is split

      Returns HTMLElement[]

      All the nodes for the given id

    • Parameters

      • node: HTMLElement

        The node to check for being a cell node

      Returns boolean

      True if the node is a cell node

    • Parameters

      • node: HTMLElement

        The node to check for being a row node

      Returns boolean

      True if the node is a row node

    • Move to deeper level in the expression

      Parameters

      • shift: boolean

        True if shift is pressed

      Returns boolean | void

      False if no node, void otherwise

    • Move to previous term in the expression

      Parameters

      • shift: boolean

        True if shift is pressed

      Returns boolean | void

      False if no node, void otherwise

    • Move to next term in the expression

      Parameters

      • shift: boolean

        True if shift is pressed

      Returns boolean | void

      False if no node, void otherwise

    • Move to a specified node, unless it is null

      Parameters

      • node: HTMLElement

        The node to move it

      Returns boolean | void

      False if no node, void otherwise

    • Move to an adjacent table cell

      Parameters

      • di: number

        Change in row number

      • dj: number

        Change in column number

      Returns boolean | void

      False if no such cell, void otherwise

    • Move to higher level in expression

      Parameters

      • shift: boolean

        True if shift is pressed

      Returns boolean | void

      False if no node, void otherwise

    • Navigate one step to the right on the same level.

      Parameters

      • node: HTMLElement

        The current element.

      Returns HTMLElement

      The next element.

    • Cycles to next speech style or preference if possible and recomputes the speech for the expression.

      Returns void

    • Get index for cell to jump to.

      Parameters

      • n: number

        The number key that was pressed

      Returns boolean | void

      False if not in a table or no such cell to jump to.

    • Parameters

      • node: HTMLElement

        The node whose parent ID we want

      Returns string

      The node's parent's semantic ID

    • Return to a previous location (loop through them). If no saved marks, go to the last previous position, or if not, the top level.

      Returns void

    • Navigate one step to the left on the same level.

      Parameters

      • node: HTMLElement

        The current element.

      Returns HTMLElement

      The next element.

    • Restarts the explorer after a promise resolves (e.g., for an maction rerender)

      Parameters

      • promise: Promise<void>

        The promise to restart after

      Returns Promise<void>

    • Get the element's semantic root node. We compute this from the root id given in the semantic structure. The semantic structure is an sexp either of the form 0 or (0 1 (2 ...) ...). We can safely assume that the root node contains the speech for the entire structure.

      If for some reason the semantic structure is not available, we return the first speech node found in the expression.

      Returns HTMLElement

      The semantic root or first speech node.

    • Set the currently selected node and speak its label, if requested.

      Parameters

      • node: HTMLElement

        The node that should become current

      • addDescription: boolean = false

        True if the speech node should get a description

      Returns void

    • The space key opens the menu, so it propagates, but we retain the current focus to refocus it when the menu closes.

      Returns boolean

      Don't cancel the event

    • Create a new speech node and sets its needed attributes, then add it to the container and focus it. If there is and old speech node, remove it after a delay (the delay is needed for Orca on Linux).

      Parameters

      • speech: string

        The string to speak

      • braille: string = ''

        The braille string

      • ssml: string[] = null

        The SSML attributes to add

      • description: string = ...

        The description to add to the speech

      Returns void

    • Get the SSML attribute array

      Parameters

      • node: HTMLElement

        The node whose SSML attributes are to be obtained

      • center: SemAttr

        The name of the SSML attribute between pre and postfix

      Returns string[]

      The prefix/speech or summary/postfix array

    • Parameters

      • node: HTMLElement

        A node that may be in a table cell

      Returns HTMLElement

      The HTML node for the table cell containing it, or null

    • Executiving the trigger the link action.

      Parameters

      • node: HTMLElement

        The node with the link.

      Returns boolean

      True if link was successfully triggered.

    • Programmatically triggers a link if the focused node contains one.

      Parameters

      • event: KeyboardEvent

        The keyboard event for the last keydown event.

      Returns boolean

      True if link was successfully triggered.

    • Programmatically triggers a link if the clicked mouse event contains one.

      Returns boolean

      True if link was successfully triggered.

    • Determine if an event that is not otherwise mapped should be allowed to propagate.

      Parameters

      • event: KeyboardEvent

        The event to check

      Returns boolean

      True if not active or the event has a modifier

    • Creator pattern for explorers.

      Type Parameters

      • T

      Parameters

      • document: A11yDocument

        The current document.

      • pool: ExplorerPool

        The explorer pool.

      • region: Region<T>

        A region to display results.

      • node: HTMLElement

        The node on which the explorer works.

      • ...rest: any[]

        Remaining information.

      Returns Explorer

      An object of the particular explorer class.