ArrayEquationNode
ArrayEquationNode class
Specifies the Equation-Array function, an object consisting of one or more equations.
class ArrayEquationNode extends EquationNode;
Constructors
Name | Description |
---|---|
constructor(EquationNode) | Constructs from a parent object convertible to this. |
Methods
Method | Description |
---|---|
equals(object) | Determine whether the current equation node is equal to the specified node |
isNull() | Checks whether the implementation object is null. |
getStartIndex() | Gets the start index of the characters. |
getLength() | Gets the length of the characters. |
getFont() | Returns the font of this object. |
getTextOptions() | Returns the text options. |
setWordArtStyle(PresetWordArtStyle) | Sets the preset WordArt style. |
getParentNode() | Specifies the parent node of the current node |
setParentNode(EquationNode) | Specifies the parent node of the current node |
getType() | Represents the type of the node. |
getEquationType() | Get the equation type of the current node |
toLaTeX() | Convert this equtation to LaTeX expression. |
toMathML() | Convert this equtation to MathML expression. |
addChild(EquationNodeType) | Insert a node of the specified type at the end of the child node list of the current node. |
addChild(EquationNode) | Inserts the specified node at the end of the current node’s list of child nodes. |
insertChild(number, EquationNodeType) | Inserts a node of the specified type at the specified index position in the current node’s child node list. |
insertAfter(EquationNodeType) | Inserts the specified node after the current node. |
insertBefore(EquationNodeType) | Inserts the specified node before the current node. |
getChild(number) | Returns the node at the specified index among the children of the current node. |
remove() | Removes itself from the parent. |
removeChild(EquationNode) | Removes the specified node from the current node’s children. |
removeChild(number) | Removes the node at the specified index from the current node’s children. |
removeAllChildren() | Removes all the child nodes of the current node. |
static createNode(EquationNodeType, Workbook, EquationNode) | Create a node of the specified type. |
constructor(EquationNode)
Constructs from a parent object convertible to this.
constructor(obj: EquationNode);
Parameters:
Parameter | Type | Description |
---|---|---|
obj | EquationNode | The parent object. |
equals(object)
Determine whether the current equation node is equal to the specified node
equals(obj: object) : boolean;
Parameters:
Parameter | Type | Description |
---|---|---|
obj | object | The specified node |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getStartIndex()
Gets the start index of the characters.
getStartIndex() : number;
getLength()
Gets the length of the characters.
getLength() : number;
getFont()
Returns the font of this object.
getFont() : Font;
Returns
getTextOptions()
Returns the text options.
getTextOptions() : TextOptions;
Returns
setWordArtStyle(PresetWordArtStyle)
Sets the preset WordArt style.
setWordArtStyle(style: PresetWordArtStyle) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
style | PresetWordArtStyle | The preset WordArt style. |
Remarks
Only for the text of shape/chart.
getParentNode()
Specifies the parent node of the current node
getParentNode() : EquationNode;
Returns
setParentNode(EquationNode)
Specifies the parent node of the current node
setParentNode(value: EquationNode) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | EquationNode | The value to set. |
getType()
Represents the type of the node.
getType() : TextNodeType;
Returns
getEquationType()
Get the equation type of the current node
getEquationType() : EquationNodeType;
Returns
toLaTeX()
Convert this equtation to LaTeX expression.
toLaTeX() : string;
toMathML()
Convert this equtation to MathML expression.
toMathML() : string;
addChild(EquationNodeType)
Insert a node of the specified type at the end of the child node list of the current node.
addChild(equationType: EquationNodeType) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
equationType | EquationNodeType | Types of Equation Nodes |
Returns
If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
addChild(EquationNode)
Inserts the specified node at the end of the current node’s list of child nodes.
addChild(node: EquationNode) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
node | EquationNode | The specified node |
insertChild(number, EquationNodeType)
Inserts a node of the specified type at the specified index position in the current node’s child node list.
insertChild(index: number, equationType: EquationNodeType) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
index | number | index value |
equationType | EquationNodeType | Types of Equation Nodes |
Returns
If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
insertAfter(EquationNodeType)
Inserts the specified node after the current node.
insertAfter(equationType: EquationNodeType) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
equationType | EquationNodeType | Types of Equation Nodes |
Returns
If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
insertBefore(EquationNodeType)
Inserts the specified node before the current node.
insertBefore(equationType: EquationNodeType) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
equationType | EquationNodeType | Types of Equation Nodes |
Returns
If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
getChild(number)
Returns the node at the specified index among the children of the current node.
getChild(index: number) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
index | number | Index of the node |
Returns
Returns the corresponding node if the specified node exists, otherwise returns null.
remove()
Removes itself from the parent.
remove() : void;
removeChild(EquationNode)
Removes the specified node from the current node’s children.
removeChild(node: EquationNode) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
node | EquationNode | Node to be deleted. |
removeChild(number)
Removes the node at the specified index from the current node’s children.
removeChild(index: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
index | number | Index of the node |
removeAllChildren()
Removes all the child nodes of the current node.
removeAllChildren() : void;
createNode(EquationNodeType, Workbook, EquationNode)
Create a node of the specified type.
static createNode(equationType: EquationNodeType, workbook: Workbook, parent: EquationNode) : EquationNode;
Parameters:
Parameter | Type | Description |
---|---|---|
equationType | EquationNodeType | Types of Equation Nodes |
workbook | Workbook | The workbook object associated with the equation |
parent | EquationNode | The parent node where this node is located |
Returns
If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.