NaryEquationNode

NaryEquationNode class

This class specifies an n-ary operator equation consisting of an n-ary operator, a base (or operand), and optional upper and lower bounds.

class NaryEquationNode extends EquationNode;

Constructors

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

Methods

Method	Description
isHideSubscript()	Whether to display the lower bound
setIsHideSubscript(boolean)	Whether to display the lower bound
isHideSuperscript()	Whether to display the upper bound
setIsHideSuperscript(boolean)	Whether to display the upper bound
getLimitLocation()	This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.
setLimitLocation(EquationLimitLocationType)	This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.
getNaryOperator()	an n-ary operator.e.g “∑”. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.
setNaryOperator(string)	an n-ary operator.e.g “∑”. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.
getNaryOperatorType()	an n-ary operator.e.g “∑”
setNaryOperatorType(EquationMathematicalOperatorType)	an n-ary operator.e.g “∑”
getNaryGrow()	This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.
setNaryGrow(boolean)	This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.
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
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.

isHideSubscript()

Whether to display the lower bound

isHideSubscript() : boolean;

setIsHideSubscript(boolean)

Whether to display the lower bound

setIsHideSubscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isHideSuperscript()

Whether to display the upper bound

isHideSuperscript() : boolean;

setIsHideSuperscript(boolean)

Whether to display the upper bound

setIsHideSuperscript(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getLimitLocation()

This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.

getLimitLocation() : EquationLimitLocationType;

Returns

EquationLimitLocationType

setLimitLocation(EquationLimitLocationType)

This attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-ary operator, or positioned just to the right of the operator.

setLimitLocation(value: EquationLimitLocationType) : void;

Parameters:

Parameter	Type	Description
value	EquationLimitLocationType	The value to set.

getNaryOperator()

an n-ary operator.e.g “∑”. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.

getNaryOperator() : string;

Remarks

It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.

setNaryOperator(string)

an n-ary operator.e.g “∑”. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this property setting if you cannot find the character you need in a known type.

setNaryOperator(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.

getNaryOperatorType()

an n-ary operator.e.g “∑”

getNaryOperatorType() : EquationMathematicalOperatorType;

Returns

EquationMathematicalOperatorType

setNaryOperatorType(EquationMathematicalOperatorType)

an n-ary operator.e.g “∑”

setNaryOperatorType(value: EquationMathematicalOperatorType) : void;

Parameters:

Parameter	Type	Description
value	EquationMathematicalOperatorType	The value to set.

getNaryGrow()

This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.

getNaryGrow() : boolean;

setNaryGrow(boolean)

This attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as integrals and summations do not grow to match the size of their operand height. When on, the n-ary operator grows vertically to match its operand height.

setNaryGrow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

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

Font

getTextOptions()

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

Specifies the parent node of the current node

getParentNode() : EquationNode;

Returns

EquationNode

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

TextNodeType

getEquationType()

Get the equation type of the current node

getEquationType() : EquationNodeType;

Returns

EquationNodeType

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.