MatrixEquationNode

MatrixEquationNode class

This class specifies the Matrix equation, consisting of one or more elements laid out in one or more rows and one or more columns.

class MatrixEquationNode extends EquationNode;

Constructors

Constructor	Description
constructor(EquationNode)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
baseJc	EquationVerticalJustificationType	This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.
isHidePlaceholder	boolean	This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.
startIndex	number	Readonly. Gets the start index of the characters.
length	number	Readonly. Gets the length of the characters.
font	Font	Readonly. Returns the font of this object.
textOptions	TextOptions	Readonly. Returns the text options.
parentNode	EquationNode	Specifies the parent node of the current node
equationType	EquationNodeType	Readonly. Get the equation type of the current node

Methods

Method	Description
getBaseJc()	@deprecated. Please use the ‘baseJc’ property instead. This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.
setBaseJc(EquationVerticalJustificationType)	@deprecated. Please use the ‘baseJc’ property instead. This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.
isHidePlaceholder()	@deprecated. Please use the ‘isHidePlaceholder’ property instead. This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.
setIsHidePlaceholder(boolean)	@deprecated. Please use the ‘isHidePlaceholder’ property instead. This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.
isNull()	Checks whether the implementation object is null.
getStartIndex()	@deprecated. Please use the ‘startIndex’ property instead. Gets the start index of the characters.
getLength()	@deprecated. Please use the ’length’ property instead. Gets the length of the characters.
getFont()	@deprecated. Please use the ‘font’ property instead. Returns the font of this object.
getTextOptions()	@deprecated. Please use the ’textOptions’ property instead. Returns the text options.
setWordArtStyle(PresetWordArtStyle)	Sets the preset WordArt style.
getParentNode()	@deprecated. Please use the ‘parentNode’ property instead. Specifies the parent node of the current node
setParentNode(EquationNode)	@deprecated. Please use the ‘parentNode’ property instead. Specifies the parent node of the current node
getEquationType()	@deprecated. Please use the ’equationType’ property instead. 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.
equals(Object)	Determine whether the current equation node is equal to the specified node
getType()	Represents the type of the node.

constructor(EquationNode)

Constructs from a parent object convertible to this.

constructor(obj: EquationNode);

Parameters:

Parameter	Type	Description
obj	EquationNode	The parent object.

baseJc

This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.

baseJc : EquationVerticalJustificationType;

isHidePlaceholder

This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.

isHidePlaceholder : boolean;

startIndex

Readonly. Gets the start index of the characters.

startIndex : number;

length

Readonly. Gets the length of the characters.

length : number;

font

Readonly. Returns the font of this object.

font : Font;

textOptions

Readonly. Returns the text options.

textOptions : TextOptions;

parentNode

Specifies the parent node of the current node

parentNode : EquationNode;

equationType

Readonly. Get the equation type of the current node

equationType : EquationNodeType;

getBaseJc()

@deprecated. Please use the ‘baseJc’ property instead. This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.

getBaseJc() : EquationVerticalJustificationType;

Returns

EquationVerticalJustificationType

setBaseJc(EquationVerticalJustificationType)

@deprecated. Please use the ‘baseJc’ property instead. This attribute specifies the justification of the matrix. Text outside of the matrix can be aligned with the bottom, top, or center of a matrix function. Default, the matrix assumes center justification.

setBaseJc(value: EquationVerticalJustificationType) : void;

Parameters:

Parameter	Type	Description
value	EquationVerticalJustificationType	The value to set.

isHidePlaceholder()

@deprecated. Please use the ‘isHidePlaceholder’ property instead. This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.

isHidePlaceholder() : boolean;

setIsHidePlaceholder(boolean)

@deprecated. Please use the ‘isHidePlaceholder’ property instead. This attribute specifies the Hide Placeholders property on a matrix. When this property is on, placeholders do not appear in the matrix.Default, placeholders do appear such that the locations where text can be inserted are made visible.

setIsHidePlaceholder(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getStartIndex()

@deprecated. Please use the ‘startIndex’ property instead. Gets the start index of the characters.

getStartIndex() : number;

getLength()

@deprecated. Please use the ’length’ property instead. Gets the length of the characters.

getLength() : number;

getFont()

@deprecated. Please use the ‘font’ property instead. Returns the font of this object.

getFont() : Font;

Returns

Font

getTextOptions()

@deprecated. Please use the ’textOptions’ property instead. Returns the text options.

getTextOptions() : TextOptions;

Returns

TextOptions

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()

@deprecated. Please use the ‘parentNode’ property instead. Specifies the parent node of the current node

getParentNode() : EquationNode;

Returns

EquationNode

setParentNode(EquationNode)

@deprecated. Please use the ‘parentNode’ property instead. Specifies the parent node of the current node

setParentNode(value: EquationNode) : void;

Parameters:

Parameter	Type	Description
value	EquationNode	The value to set.

getEquationType()

@deprecated. Please use the ’equationType’ property instead. Get the equation type of the current node

getEquationType() : EquationNodeType;

Returns

EquationNodeType

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.

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

getType()

Represents the type of the node.

getType() : TextNodeType;

Returns

TextNodeType