Interface MmlNode

The MmlNode interface (extends Node interface)

interface MmlNode {
    arity: number;
    attributes: Attributes;
    childNodes: MmlNode[];
    factory: NodeFactory<MmlNode, MmlNodeClass>;
    isToken: boolean;
    parent: MmlNode;
    Parent: MmlNode;
    texClass: number;
    appendChild(child: MmlNode): MmlNode;
    childIndex(child: MmlNode): number;
    childPosition(): number;
    copy(keepIds?: boolean): MmlNode;
    core(): MmlNode;
    coreIndex(): number;
    coreMO(): MmlNode;
    findNodes(kind: string): MmlNode[];
    getAllProperties(): PropertyList;
    getProperty(name: string): Property;
    getPropertyNames(): string[];
    hasSpacingAttributes(): boolean;
    inheritAttributesFrom(node: MmlNode): void;
    isKind(kind: string): boolean;
    mError(message: string, options: PropertyList, short?: boolean): MmlNode;
    removeChild(child: MmlNode): MmlNode;
    removeProperty(...names: string[]): void;
    replaceChild(newChild: MmlNode, oldChild: MmlNode): MmlNode;
    setChildren(children: MmlNode[]): void;
    setInheritedAttributes(
        attributes: AttributeList,
        display: boolean,
        level: number,
        prime: boolean,
    ): void;
    setProperty(name: string, value: Property): void;
    setTeXclass(prev: MmlNode): MmlNode;
    texSpacing(): string;
    verifyTree(options?: PropertyList): void;
    walkTree(func: (node: MmlNode, data?: any) => void, data?: any): void;
}

Hierarchy (View Summary)

Node<MmlNode, MmlNodeClass>
- MmlNode

Implemented by

Properties

`Readonly`arity

arity: number

The expected number of children (-1 means use inferred mrow)

attributes

attributes: Attributes

The attributes (explicit and inherited) for this node

childNodes

childNodes: MmlNode[]

@ override

`Readonly`factory

factory: NodeFactory<MmlNode, MmlNodeClass>

The NodeFactory to use to create additional nodes, as needed

`Readonly`isToken

isToken: boolean

Test various properties of MathML nodes

parent

parent: MmlNode

The actual parent in the tree

`Readonly`Parent

Parent: MmlNode

Get the parent node (skipping inferred mrows and other nodes marked as notParent)

texClass

texClass: number

The TeX class for this node

Methods

appendChild

appendChild(child: MmlNode): MmlNode
Parameters
- child: MmlNode
  A node to add to this node's children
Returns MmlNode
The child node that was added
Inherited from Node.appendChild
- Defined in ts/core/Tree/Node.ts:92

childIndex

childIndex(child: MmlNode): number
Parameters
- child: MmlNode
  A child node whose index in childNodes is desired
Returns number
The index of the child in childNodes, or null if not found
Inherited from Node.childIndex
- Defined in ts/core/Tree/Node.ts:111

childPosition

childPosition(): number
Returns number
The index of this node in its parent's childNodes array.
- Defined in ts/core/MmlTree/MmlNode.ts:215

copy

copy(keepIds?: boolean): MmlNode
Parameters
- OptionalkeepIds: boolean
  True if id attributes should be preserved
Returns MmlNode
A copy of the MmlNode and its children (without inherited attributes)
Overrides Node.copy
- Defined in ts/core/MmlTree/MmlNode.ts:192

core

core(): MmlNode
Returns MmlNode
For embellished operators, the child node that contains the core node. For non-embellished nodes, the original node.
- Defined in ts/core/MmlTree/MmlNode.ts:198

coreIndex

coreIndex(): number
Returns number
For embellished operators, the index of the child node containing the core . For non-embellished nodes, 0.
- Defined in ts/core/MmlTree/MmlNode.ts:210

coreMO

coreMO(): MmlNode
Returns MmlNode
For embellished operators, the core element (at whatever depth). For non-embellished nodes, the original node itself.
- Defined in ts/core/MmlTree/MmlNode.ts:204

findNodes

findNodes(kind: string): MmlNode[]
Parameters
- kind: string
  The kind of nodes to be located in the tree
Returns MmlNode[]
An array of nodes that are children (at any depth) of the given kind
Inherited from Node.findNodes
- Defined in ts/core/Tree/Node.ts:122

getAllProperties

getAllProperties(): PropertyList
Returns PropertyList
The propery list containing all the properties of the node
Inherited from Node.getAllProperties
- Defined in ts/core/Tree/Node.ts:70

getProperty

getProperty(name: string): Property
Parameters
- name: string
  The name of the property to get
Returns Property
The value of the named property
Inherited from Node.getProperty
- Defined in ts/core/Tree/Node.ts:60

getPropertyNames

getPropertyNames(): string[]
Returns string[]
An array of the names of every property currently defined
Inherited from Node.getPropertyNames
- Defined in ts/core/Tree/Node.ts:65

hasSpacingAttributes

hasSpacingAttributes(): boolean
Returns boolean
The core mo element has an explicit 'form', 'lspace', or 'rspace' attribute
- Defined in ts/core/MmlTree/MmlNode.ts:233

inheritAttributesFrom

inheritAttributesFrom(node: MmlNode): void
Set the nodes inherited attributes based on the attributes of the given node (used for creating extra nodes in the tree after setInheritedAttributes has already run)
Parameters
- node: MmlNode
  The node whose attributes are to be used as a template
Returns void
- Defined in ts/core/MmlTree/MmlNode.ts:257

isKind

isKind(kind: string): boolean
Parameters
- kind: string
  The type of node to test for
Returns boolean
True when the node is of the given type
Inherited from Node.isKind
- Defined in ts/core/Tree/Node.ts:81

mError

mError(message: string, options: PropertyList, short?: boolean): MmlNode
Replace the current node with an error message (or the name of the node)
Parameters
- message: string
  The error message to use
- options: PropertyList
  The options telling how much to verify
- Optionalshort: boolean
  True means use just the kind if not using full errors
Returns MmlNode
The construted merror
- Defined in ts/core/MmlTree/MmlNode.ts:267

removeChild

removeChild(child: MmlNode): MmlNode
Parameters
- child: MmlNode
  Child node to be removed
Returns MmlNode
The old child node that was removed
Inherited from Node.removeChild
- Defined in ts/core/Tree/Node.ts:105

removeProperty

removeProperty(...names: string[]): void
Parameters
- ...names: string[]
  The names of the properties to be removed
Returns void
Inherited from Node.removeProperty
- Defined in ts/core/Tree/Node.ts:75

replaceChild

replaceChild(newChild: MmlNode, oldChild: MmlNode): MmlNode
Parameters
- newChild: MmlNode
  A child node to be inserted
- oldChild: MmlNode
  A child node to be replaced
Returns MmlNode
The old child node that was removed
Inherited from Node.replaceChild
- Defined in ts/core/Tree/Node.ts:99

setChildren

setChildren(children: MmlNode[]): void
Parameters
- children: MmlNode[]
  The child nodes to add to this node
Returns void
Inherited from Node.setChildren
- Defined in ts/core/Tree/Node.ts:86

setInheritedAttributes

setInheritedAttributes(
    attributes: AttributeList,
    display: boolean,
    level: number,
    prime: boolean,
): void
Sets the nodes inherited attributes, and pushes them to the nodes children.
Parameters
- attributes: AttributeList
  The list of inheritable attributes (with the node kinds from which they came)
- display: boolean
  The displaystyle to inherit
- level: number
  The scriptlevel to inherit
- prime: boolean
  The TeX prime style to inherit (T vs. T', etc).
Returns void
- Defined in ts/core/MmlTree/MmlNode.ts:244

setProperty

setProperty(name: string, value: Property): void
Parameters
- name: string
  The name of the property to set
- value: Property
  The value to which the property will be set
Returns void
Inherited from Node.setProperty
- Defined in ts/core/Tree/Node.ts:54

setTeXclass

setTeXclass(prev: MmlNode): MmlNode
Parameters
- prev: MmlNode
  The node that is before this one for TeX spacing purposes (not all nodes count in TeX measurements)
Returns MmlNode
The node that should be the previous node for the next one in the tree (usually, either the last child, or the node itself)
- Defined in ts/core/MmlTree/MmlNode.ts:223

texSpacing

texSpacing(): string
Returns string
The spacing to use before this element (one of TEXSPACELENGTH array above)
- Defined in ts/core/MmlTree/MmlNode.ts:228

verifyTree

verifyTree(options?: PropertyList): void
Check integrity of MathML structure
Parameters
- Optionaloptions: PropertyList
  The options controlling the check
Returns void
- Defined in ts/core/MmlTree/MmlNode.ts:274

walkTree

walkTree(func: (node: MmlNode, data?: any) => void, data?: any): void
Parameters
- func: (node: MmlNode, data?: any) => void
  A function to apply to each node in the tree rooted at this node
- Optionaldata: any
  Data to pass to the function (as state information)
Returns void
Inherited from Node.walkTree
- Defined in ts/core/Tree/Node.ts:128

Interface MmlNode

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Readonlyarity

attributes

childNodes

Readonlyfactory

ReadonlyisToken

parent

ReadonlyParent

texClass

Methods

appendChild

Parameters

Returns MmlNode

childIndex

Parameters

Returns number

childPosition

Returns number

copy

Parameters

Returns MmlNode

core

Returns MmlNode

coreIndex

Returns number

coreMO

Returns MmlNode

findNodes

Parameters

Returns MmlNode[]

getAllProperties

Returns PropertyList

getProperty

Parameters

Returns Property

getPropertyNames

Returns string[]

hasSpacingAttributes

Returns boolean

inheritAttributesFrom

Parameters

Returns void

isKind

Parameters

Returns boolean

mError

Parameters

Returns MmlNode

removeChild

Parameters

Returns MmlNode

removeProperty

Parameters

Returns void

replaceChild

Parameters

Returns MmlNode

setChildren

Parameters

Returns void

setInheritedAttributes

Parameters

Returns void

setProperty

Parameters

Returns void

setTeXclass

Parameters

Returns MmlNode

texSpacing

Returns string

verifyTree

Parameters

Returns void

`Readonly`arity

`Readonly`factory

`Readonly`isToken

`Readonly`Parent