Class ComplexityVisitor

A visitor pattern that computes complexities within the MathML tree

Hierarchy (View Summary)

MmlVisitor
- ComplexityVisitor

Constructors

constructor

new ComplexityVisitor(
factory: MmlFactory,
options: OptionList,
): ComplexityVisitor
Parameters
- factory: MmlFactory
- options: OptionList
Returns ComplexityVisitor
Overrides MmlVisitor.constructor
- Defined in ts/a11y/complexity/visitor.ts:97

Properties

collapse

collapse: Collapse

The object used to handle collapsable content

complexity

complexity: { [name: string]: number } = ...

Values used to compute complexities

factory

factory: MmlFactory

The MmlFactory for this visitor

`Protected`nodeHandlers

nodeHandlers: Map<string, VisitorFunction<MmlNode>> = ...

Holds the mapping from node kinds to visitor funcitons

options

options: OptionList

The options for this visitor

`Static`defaultAttributes

defaultAttributes: { [kind: string]: PropertyList } = ...

Attributes to include on every element of a given kind

`Static`OPTIONS

OPTIONS: OptionList = ...

The options for handling collapsing

`Static`rename

rename: PropertyList = ...

MmlNode kinds to replace with other names

`Static`variants

variants: PropertyList = ...

Translations for the internal mathvariants

Methods

`Protected`childrenComplexity

childrenComplexity(node: MmlNode): number
Parameters
- node: MmlNode
  The node whose children complexities are to be added
Returns number
The sum of the complexities, plus child complexity for each one
- Defined in ts/a11y/complexity/visitor.ts:414

`Protected`getAttributeList

getAttributeList(node: MmlNode): PropertyList
Parameters
- node: MmlNode
  The node whose attributes are to be produced
Returns PropertyList
The attribute list
Inherited from MmlVisitor.getAttributeList
- Defined in ts/core/MmlTree/MmlVisitor.ts:137

getComplexity

getComplexity(node: MmlNode): number
Parameters
- node: MmlNode
  The node whose complixity is needed
Returns number
The complexity of the node (if collapsable, then the collapsed complexity)
- Defined in ts/a11y/complexity/visitor.ts:381

`Protected`getDataAttributes

getDataAttributes(node: MmlNode): PropertyList
Create the list of data-mjx-* attributes
Parameters
- node: MmlNode
  The node whose data list is to be generated
Returns PropertyList
The final class attribute list
Inherited from MmlVisitor.getDataAttributes
- Defined in ts/core/MmlTree/MmlVisitor.ts:163

`Protected`getKind

getKind(node: MmlNode): string
Parameters
- node: MmlNode
  The node whose kind is needed
Returns string
The MamlML node name for that kind
Inherited from MmlVisitor.getKind
- Defined in ts/core/MmlTree/MmlVisitor.ts:123

removeNodeHandler

removeNodeHandler(kind: string): void
Parameters
- kind: string
Returns void
Inherited from MmlVisitor.removeNodeHandler
- Defined in ts/core/Tree/Visitor.ts:192

`Protected`setComplexity

setComplexity(node: MmlNode, complexity: number, save: boolean): number
Parameters
- node: MmlNode
  The node whose complixity is being set
- complexity: number
  The complexity for the node
- save: boolean
  True if complexity is to be set or just reported
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:396

`Protected`setDataAttribute

setDataAttribute(data: PropertyList, name: string, value: string): void
Parameters
- data: PropertyList
  The class attribute list
- name: string
  The name for the data-mjx-name attribute
- value: string
  The value of the attribute
Returns void
Inherited from MmlVisitor.setDataAttribute
- Defined in ts/core/MmlTree/MmlVisitor.ts:225

setNodeHandler

setNodeHandler(kind: string, handler: VisitorFunction<MmlNode>): void
Parameters
- kind: string
- handler: VisitorFunction<MmlNode>
Returns void
Inherited from MmlVisitor.setNodeHandler
- Defined in ts/core/Tree/Visitor.ts:185

`Protected`visitAnnotation_xmlNode

visitAnnotation_xmlNode(node: MmlNode, save: boolean): number
Can't really measure annotations, so just use a specific value
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:360

`Protected`visitAnnotationNode

visitAnnotationNode(node: MmlNode, save: boolean): number
Can't really measure annotations, so just use a specific value
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:349

visitDefault

visitDefault(node: MmlNode, save: boolean): number
For token nodes, use the content length, otherwise, add up the child complexities
Parameters
- node: MmlNode
- save: boolean
Returns number
Overrides MmlVisitor.visitDefault
- Defined in ts/a11y/complexity/visitor.ts:131

visitHtmlNode

visitHtmlNode(_node: HtmlNode<any>, ..._args: any[]): any
Parameters
- _node: HtmlNode<any>
  The XMLNode to visit
- ..._args: any[]
  Any arguments needed by the visitor
Returns any
Any return value needed for the visitor
Inherited from MmlVisitor.visitHtmlNode
- Defined in ts/core/MmlTree/MmlVisitor.ts:112

`Protected`visitMactionNode

visitMactionNode(node: MmlMaction, save: boolean): number
For actions, use the complexity of the selected child
Parameters
- node: MmlMaction
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:319

`Protected`visitMencloseNode

visitMencloseNode(node: MmlNode, save: boolean): number
For enclose, use sum of child complexities plus some for the enclose
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:307

`Protected`visitMfracNode

visitMfracNode(node: MmlNode, save: boolean): number
For a fraction, add the complexities of the children and scale by script factor, then add the fraction amount
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:150

`Protected`visitMglyphNode

visitMglyphNode(node: MmlNode, save: boolean): number
Can't really measure mglyph complexity, so just use a specific value
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node (if collapsable, then the collapsed complexity)
- Defined in ts/a11y/complexity/visitor.ts:371

`Protected`visitMoverNode

visitMoverNode(node: MmlMover, save: boolean): number
Parameters
- node: MmlMover
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:296

`Protected`visitMphantomNode

visitMphantomNode(node: MmlNode, save: boolean): number
Phantom complexity is 0
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:192

`Protected`visitMrootNode

visitMrootNode(node: MmlMroot, save: boolean): number
For roots, do the sqrt root computation and remove a bit for the root (since it is counted in the children sum but is smaller)
Parameters
- node: MmlMroot
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:177

`Protected`visitMsemanticsNode

visitMsemanticsNode(node: MmlNode, save: boolean): number
For semantics, get the complexity from the first child
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:332

`Protected`visitMsNode

visitMsNode(node: MmlNode, save: boolean): number
For ms, add the complexity of the quotes to that of the content, and use the length of that times the text factor as the complexity
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:204

`Protected`visitMsqrtNode

visitMsqrtNode(node: MmlNode, save: boolean): number
For square roots, use the child complexity plus the sqrt complexity
Parameters
- node: MmlNode
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:164

`Protected`visitMsubNode

visitMsubNode(node: MmlMsub, save: boolean): number
Parameters
- node: MmlMsub
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:242

`Protected`visitMsubsupNode

visitMsubsupNode(node: MmlMsubsup, save: boolean): number
For supscripts and superscripts use the maximum of the script complexities, multiply by the script factor, and add the base complexity. Add the child complexity for each child, and the subsup complexity.
Parameters
- node: MmlMsubsup
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:222

`Protected`visitMsupNode

visitMsupNode(node: MmlMsup, save: boolean): number
Parameters
- node: MmlMsup
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:250

`Protected`visitMunderNode

visitMunderNode(node: MmlMunder, save: boolean): number
Parameters
- node: MmlMunder
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:288

`Protected`visitMunderoverNode

visitMunderoverNode(node: MmlMunderover, save: boolean): number
For under/over, get the maximum of the complexities of the under and over elements times the script factor, and that the maximum of that with the base complexity. Add child complexity for all children, and add the underover amount.
Parameters
- node: MmlMunderover
  The node whose complixity is being computed
- save: boolean
  True if the complexity is to be saved or just returned
Returns number
The complexity of the node
- Defined in ts/a11y/complexity/visitor.ts:264

visitNode

visitNode(node: MmlNode, save: boolean): any
Parameters
- node: MmlNode
- save: boolean
Returns any
Overrides MmlVisitor.visitNode
- Defined in ts/a11y/complexity/visitor.ts:121

visitTextNode

visitTextNode(_node: TextNode, ..._args: any[]): any
Parameters
- _node: TextNode
  The TextNode to visit
- ..._args: any[]
  Any arguments needed by the visitor
Returns any
Any return value needed for the visitor
Inherited from MmlVisitor.visitTextNode
- Defined in ts/core/MmlTree/MmlVisitor.ts:98

visitTree

visitTree(node: MmlNode, id: number): number
Parameters
- node: MmlNode
- id: number
Returns number
Overrides MmlVisitor.visitTree
- Defined in ts/a11y/complexity/visitor.ts:110

visitXMLNode

visitXMLNode(_node: XMLNode, ..._args: any[]): any
Parameters
- _node: XMLNode
  The XMLNode to visit
- ..._args: any[]
  Any arguments needed by the visitor
Returns any
Any return value needed for the visitor
Inherited from MmlVisitor.visitXMLNode
- Defined in ts/core/MmlTree/MmlVisitor.ts:105

`Protected` `Static`methodName

methodName(kind: string): string
Visitor functions are named "visitKindNode" where "Kind" is replaced by the node kind; e.g., visitTextNode for kind = text.
Parameters
- kind: string
  The node kind whose method name is needed
Returns string
The name of the visitor method for the given node kind
Inherited from MmlVisitor.methodName
- Defined in ts/core/Tree/Visitor.ts:127

Class ComplexityVisitor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ComplexityVisitor

Properties

collapse

complexity

factory

ProtectednodeHandlers

options

StaticdefaultAttributes

StaticOPTIONS

Staticrename

Staticvariants

Methods

ProtectedchildrenComplexity

Parameters

Returns number

ProtectedgetAttributeList

Parameters

Returns PropertyList

getComplexity

Parameters

Returns number

ProtectedgetDataAttributes

Parameters

Returns PropertyList

ProtectedgetKind

Parameters

Returns string

removeNodeHandler

Parameters

Returns void

ProtectedsetComplexity

Parameters

Returns number

ProtectedsetDataAttribute

Parameters

Returns void

setNodeHandler

Parameters

Returns void

ProtectedvisitAnnotation_xmlNode

Parameters

Returns number

ProtectedvisitAnnotationNode

Parameters

Returns number

visitDefault

Parameters

Returns number

visitHtmlNode

Parameters

Returns any

ProtectedvisitMactionNode

Parameters

Returns number

ProtectedvisitMencloseNode

Parameters

Returns number

ProtectedvisitMfracNode

Parameters

Returns number

ProtectedvisitMglyphNode

Parameters

Returns number

ProtectedvisitMoverNode

Parameters

Returns number

ProtectedvisitMphantomNode

Parameters

Returns number

ProtectedvisitMrootNode

Parameters

`Protected`nodeHandlers

`Static`defaultAttributes

`Static`OPTIONS

`Static`rename

`Static`variants

`Protected`childrenComplexity

`Protected`getAttributeList

`Protected`getDataAttributes

`Protected`getKind

`Protected`setComplexity

`Protected`setDataAttribute

`Protected`visitAnnotation_xmlNode

`Protected`visitAnnotationNode

`Protected`visitMactionNode

`Protected`visitMencloseNode

`Protected`visitMfracNode

`Protected`visitMglyphNode

`Protected`visitMoverNode

`Protected`visitMphantomNode

`Protected`visitMrootNode

`Protected`visitMsemanticsNode

`Protected`visitMsNode

`Protected`visitMsqrtNode

`Protected`visitMsubNode

`Protected`visitMsubsupNode

`Protected`visitMsupNode

`Protected`visitMunderNode

`Protected`visitMunderoverNode

`Protected` `Static`methodName