Class MmlVisitor<N, T, D>

The visitor to serialize MathML

Type Parameters

N
The HTMLElement node class
T
The Text node class
D
The Document class

Hierarchy (View Summary)

SerializedMmlVisitor
- MmlVisitor

Constructors

constructor

new MmlVisitor<N, T, D>(factory?: MmlFactory): MmlVisitor<N, T, D>
Type Parameters
- N
- T
- D
Parameters
- factory: MmlFactory = null
  The MmlNode factory (defaults to MmlFactory if not given)
Returns MmlVisitor<N, T, D>
Inherited from SerializedMmlVisitor.constructor
- Defined in ts/core/MmlTree/MmlVisitor.ts:81

Properties

mathItem

mathItem: MathItem<N, T, D> = null

The MathItem currently being processed

`Protected`nodeHandlers

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

Holds the mapping from node kinds to visitor funcitons

options

options: OptionList = ...

The options controlling the serialization

`Static`defaultAttributes

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

Attributes to include on every element of a given kind

`Static`rename

rename: PropertyList = ...

MmlNode kinds to replace with other names

`Static`variants

variants: PropertyList = ...

Translations for the internal mathvariants

Methods

`Protected`childNodeMml

childNodeMml(node: MmlNode, space: string, nl: string): string
Parameters
- node: MmlNode
  The node whose children are to be added
- space: string
  The spaces to use for indentation
- nl: string
  The newline character (or empty)
Returns string
The serializied children
Inherited from SerializedMmlVisitor.childNodeMml
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:127

`Protected`getAttributeList

getAttributeList(node: MmlNode): PropertyList
Parameters
- node: MmlNode
Returns PropertyList
Overrides SerializedMmlVisitor.getAttributeList
- Defined in ts/ui/menu/MmlVisitor.ts:113

`Protected`getAttributes

getAttributes(node: MmlNode): string
Parameters
- node: MmlNode
  The node whose attributes are to be produced
Returns string
The attribute list as a string
Inherited from SerializedMmlVisitor.getAttributes
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:139

`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 SerializedMmlVisitor.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 SerializedMmlVisitor.getKind
- Defined in ts/core/MmlTree/MmlVisitor.ts:123

`Protected`quoteHTML

quoteHTML(value: string): string
Convert HTML special characters to entities (&, <, >, ") Convert multi-character Unicode characters to entities Convert non-ASCII characters to entities.
Parameters
- value: string
  The string to be made HTML escaped
Returns string
The string with escaping performed
Inherited from SerializedMmlVisitor.quoteHTML
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:158

removeNodeHandler

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

`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 SerializedMmlVisitor.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 SerializedMmlVisitor.setNodeHandler
- Defined in ts/core/Tree/Visitor.ts:185

visitAnnotationNode

visitAnnotationNode(node: MmlNode, space: string): string
Parameters
- node: MmlNode
  The annotation node to visit
- space: string
  The number of spaces to use for indentation
Returns string
The serializied annotation element
Inherited from SerializedMmlVisitor.visitAnnotationNode
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:96

visitDefault

visitDefault(node: MmlNode, space: string): string
The generic visiting function: Make the string version of the open tag, properly indented, with it attributes Increate the indentation level Add the childnodes Add the end tag with proper spacing (empty tags have the close tag following directly)
Parameters
- node: MmlNode
  The node to visit
- space: string
  The number of spaces to use for indentation
Returns string
The serialization of the given node
Inherited from SerializedMmlVisitor.visitDefault
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:112

visitHtmlNode

visitHtmlNode(node: HtmlNode<any>, _space: string): string
Parameters
- node: HtmlNode<any>
  The HTML node to visit
- _space: string
  The amount of indenting for this node
Returns string
The serialization of the HTML
Inherited from SerializedMmlVisitor.visitHtmlNode
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:71

visitInferredMrowNode

visitInferredMrowNode(node: MmlNode, space: string): string
Visit an inferred mrow, but don't add the inferred row itself (since it is supposed to be inferred).
Parameters
- node: MmlNode
  The inferred mrow to visit
- space: string
  The amount of indenting for this node
Returns string
The serialized contents of the mrow, properly indented
Inherited from SerializedMmlVisitor.visitInferredMrowNode
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:83

visitMathNode

visitMathNode(node: MmlNode, space: string): string
Parameters
- node: MmlNode
  The math node to visit
- space: string
  The number of spaces to use for indentation
Returns string
The serialized math element
- Defined in ts/ui/menu/MmlVisitor.ts:93

visitNode

visitNode(node: MmlNode, ...args: any[]): any
Parameters
- node: MmlNode
- ...args: any[]
Returns any
Inherited from SerializedMmlVisitor.visitNode
- Defined in ts/core/Tree/Visitor.ts:166

visitTeXAtomNode

visitTeXAtomNode(node: MmlNode, space: string): any
Parameters
- node: MmlNode
- space: string
Returns any
- Defined in ts/ui/menu/MmlVisitor.ts:74

visitTextNode

visitTextNode(node: TextNode, _space: string): string
Parameters
- node: TextNode
  The text node to visit
- _space: string
  The amount of indenting for this node
Returns string
The (HTML-quoted) text of the node
Inherited from SerializedMmlVisitor.visitTextNode
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:53

visitTree

visitTree(node: MmlNode, math?: MathItem<N, T, D>, options?: OptionList): any
Parameters
- node: MmlNode
  The internal MathML node to serialize
- math: MathItem<N, T, D> = null
  The MathItem for this node
- options: OptionList = {}
  The options controlling the processing
Returns any
Overrides SerializedMmlVisitor.visitTree
- Defined in ts/ui/menu/MmlVisitor.ts:61

visitXMLNode

visitXMLNode(node: XMLNode, space: string): string
Parameters
- node: XMLNode
  The XML node to visit
- space: string
  The amount of indenting for this node
Returns string
The serialization of the XML node
Inherited from SerializedMmlVisitor.visitXMLNode
- Defined in ts/core/MmlTree/SerializedMmlVisitor.ts:62

`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 SerializedMmlVisitor.methodName
- Defined in ts/core/Tree/Visitor.ts:127

Class MmlVisitor<N, T, D>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MmlVisitor<N, T, D>

Properties

mathItem

ProtectednodeHandlers

options

StaticdefaultAttributes

Staticrename

Staticvariants

Methods

ProtectedchildNodeMml

Parameters

Returns string

ProtectedgetAttributeList

Parameters

Returns PropertyList

ProtectedgetAttributes

Parameters

Returns string

ProtectedgetDataAttributes

Parameters

Returns PropertyList

ProtectedgetKind

Parameters

Returns string

ProtectedquoteHTML

Parameters

Returns string

removeNodeHandler

Parameters

Returns void

ProtectedsetDataAttribute

Parameters

Returns void

setNodeHandler

Parameters

Returns void

visitAnnotationNode

Parameters

Returns string

visitDefault

Parameters

Returns string

visitHtmlNode

Parameters

Returns string

visitInferredMrowNode

Parameters

Returns string

visitMathNode

Parameters

Returns string

visitNode

Parameters

Returns any

visitTeXAtomNode

Parameters

Returns any

visitTextNode

Parameters

Returns string

visitTree

Parameters

Returns any

visitXMLNode

Parameters

Returns string

Protected StaticmethodName

Parameters

Returns string

`Protected`nodeHandlers

`Static`defaultAttributes

`Static`rename

`Static`variants

`Protected`childNodeMml

`Protected`getAttributeList

`Protected`getAttributes

`Protected`getDataAttributes

`Protected`getKind

`Protected`quoteHTML

`Protected`setDataAttribute

`Protected` `Static`methodName