Class Collapse

The class for determining if a subtree can be collapsed

Index

Constructors

Properties

collapse complexity cutoff marker NOCOLLAPSE

Methods

addMrow canUncollapse check defaultCheck findChild findChildText getText makeAction makeActionGroup makeActions makeCollapse recordCollapse splitAttribute uncollapseChild unrecordCollapse

Constructors

constructor

new Collapse(visitor: ComplexityVisitor): Collapse
Parameters
- visitor: ComplexityVisitor
  The visitor for computing complexities
Returns Collapse
- Defined in ts/a11y/complexity/collapse.ts:361

Properties

collapse

collapse: CollapseFunctionMap = ...

The type-to-function mapping for semantic types

Param: node

The current node

Param: complexity

The current complexity

Returns

The newly computed complexity

complexity

complexity: ComplexityVisitor

The complexity object containing this one

cutoff

cutoff: TypeRole<number> = ...

The cutt-off complexity values for when a structure of the given type should collapse

marker

marker: TypeRole<string> = ...

These are the characters to use for the various collapsed elements (if an object, then semantic-role is used to get the character from the object)

`Static`NOCOLLAPSE

NOCOLLAPSE: number = 10000000

A constant to use to indicate no collapsing

Methods

addMrow

addMrow(node: MmlNode): MmlNode
If the $node is to be collapsible, add an mrow to it instead so that we can wrap it
in an maction (can't put one around the node).$
Parameters
- node: MmlNode
  The math node to create an mrow for
Returns MmlNode
The newly created mrow
- Defined in ts/a11y/complexity/collapse.ts:670

`Protected`canUncollapse

canUncollapse(node: MmlNode, n: number, m?: number): MmlNode
Parameters
- node: MmlNode
  The node to check if its child is collapsible
- n: number
  The position of the child node to check
- m: number = 1
  The number of children node must have
Returns MmlNode
The child node that was collapsed (or null)
- Defined in ts/a11y/complexity/collapse.ts:448

check

check(node: MmlNode, complexity: number): number
Check if a node should be collapsible and insert the maction node to handle that. Return the updated complexity.
Parameters
- node: MmlNode
  The node to check
- complexity: number
  The current complexity of the node
Returns number
The revised complexity
- Defined in ts/a11y/complexity/collapse.ts:374

`Protected`defaultCheck

defaultCheck(node: MmlNode, complexity: number, type: string): number
Check if the complexity exceeds the cutoff value for the type
Parameters
- node: MmlNode
  The node to check
- complexity: number
  The current complexity of the node
- type: string
  The semantic type of the node
Returns number
The revised complexity
- Defined in ts/a11y/complexity/collapse.ts:393

`Protected`findChild

findChild(node: MmlNode, id: string): MmlNode
Parameters
- node: MmlNode
  The node whose child is to be located
- id: string
  The (semantic) id of the child to be found
Returns MmlNode
The child node (or null if not found)
- Defined in ts/a11y/complexity/collapse.ts:525

`Protected`findChildText

findChildText(node: MmlNode, id: string): string
Parameters
- node: MmlNode
  The node whose child text is needed
- id: string
  The (semantic) id of the child needed
Returns string
The text of the specified child node
- Defined in ts/a11y/complexity/collapse.ts:515

`Protected`getText

getText(node: MmlNode): string
Parameters
- node: MmlNode
  The node whose text content is needed
Returns string
The text of the node (and its children), combined
- Defined in ts/a11y/complexity/collapse.ts:505

makeAction

makeAction(root: MmlNode, node: MmlNode, extra: string[]): void
Parameters
- root: MmlNode
  The top of the MathML tree
- node: MmlNode
  The node to make collapsible by replacing with an maction
- extra: string[]
  The extra nodes (if any) that need to be included in linked mactions
Returns void
- Defined in ts/a11y/complexity/collapse.ts:594

makeActionGroup

makeActionGroup(root: MmlNode, action: MmlNode, extra: string[]): void
Parameters
- root: MmlNode
  The root of the MathML tree
- action: MmlNode
  The maction node that controls the potential group
- extra: string[]
  The list of extra nodes for this group (if non-empty)
Returns void
- Defined in ts/a11y/complexity/collapse.ts:634

makeActions

makeActions(root: MmlNode, nodes: MmlNode[], parts: SemanticMap): void
Parameters
- root: MmlNode
  The top of the MathML tree
- nodes: MmlNode[]
  The list of nodes to replace by maction nodes
- parts: SemanticMap
  The map of ids to extra nodes
Returns void
- Defined in ts/a11y/complexity/collapse.ts:574

makeCollapse

makeCollapse(node: MmlNode, id: number, parts: SemanticMap): number
Add maction nodes to the nodes in the tree that can collapse
Parameters
- node: MmlNode
  The root of the tree to check
- id: number
  The initial id to use
- parts: SemanticMap
  The map of ids to extra nodes
Returns number
The initial id used
- Defined in ts/a11y/complexity/collapse.ts:544

`Protected`recordCollapse

recordCollapse(node: MmlNode, complexity: number, text: string): number
Parameters
- node: MmlNode
  The node to check
- complexity: number
  The current complexity of the node
- text: string
  The text to use for the collapsed node
Returns number
The revised complexity for the collapsed node
- Defined in ts/a11y/complexity/collapse.ts:417

`Protected`splitAttribute

splitAttribute(node: MmlNode, id: string): string[]
Parameters
- node: MmlNode
  The node whose attribute is to be split
- id: string
  The name of the data-semantic attribute to split
Returns string[]
Array of ids in the attribute split at commas
- Defined in ts/a11y/complexity/collapse.ts:497

`Protected`uncollapseChild

uncollapseChild(
    complexity: number,
    node: MmlNode,
    n: number,
    m?: number,
): number
Parameters
- complexity: number
  The current complexity
- node: MmlNode
  The node to check
- n: number
  The position of the child node to check
- m: number = 1
  The number of children the node must have
Returns number
The updated complexity
- Defined in ts/a11y/complexity/collapse.ts:475

`Protected`unrecordCollapse

unrecordCollapse(node: MmlNode): void
Remove collapse markers (to move them to a parent node)
Parameters
- node: MmlNode
  The node to uncollapse
Returns void
- Defined in ts/a11y/complexity/collapse.ts:433

Class Collapse

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Collapse

Properties

collapse

Param: node

Param: complexity

Returns

complexity

cutoff

marker

StaticNOCOLLAPSE

Methods

addMrow

Parameters

Returns MmlNode

ProtectedcanUncollapse

Parameters

Returns MmlNode

check

Parameters

Returns number

ProtecteddefaultCheck

Parameters

Returns number

ProtectedfindChild

Parameters

Returns MmlNode

ProtectedfindChildText

Parameters

Returns string

ProtectedgetText

Parameters

Returns string

makeAction

Parameters

Returns void

makeActionGroup

Parameters

Returns void

makeActions

Parameters

Returns void

makeCollapse

Parameters

Returns number

ProtectedrecordCollapse

Parameters

Returns number

ProtectedsplitAttribute

Parameters

Returns string[]

ProtecteduncollapseChild

Parameters

Returns number

ProtectedunrecordCollapse

Parameters

Returns void

Settings

On This Page

`Static`NOCOLLAPSE

`Protected`canUncollapse

`Protected`defaultCheck

`Protected`findChild

`Protected`findChildText

`Protected`getText

`Protected`recordCollapse

`Protected`splitAttribute

`Protected`uncollapseChild

`Protected`unrecordCollapse