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.

Properties

NameTypeDescription
IsHideSubscriptbooleanWhether to display the lower bound
IsHideSuperscriptbooleanWhether to display the upper bound
LimitLocationintThis attribute specifies the location of limits in n-ary operators. Limits can be either centered above and below the n-
NaryOperatorStringan n-ary operator.e.g “∑”. It is strongly recommended to use attribute NaryOperatorType to set n-ary operator. Use this
NaryOperatorTypeintan n-ary operator.e.g “∑” The value of the property is EquationMathematicalOperatorType integer constant.
NaryGrowbooleanThis attribute specifies the growth property of n-ary operators at the document level. When off, n-ary operators such as
ParentNodeEquationNodeSpecifies the parent node of the current node
TypeintRepresents the type of the node. The value of the property is TextNodeType integer constant.
EquationTypeintGet the equation type of the current node The value of the property is EquationNodeType integer constant.
StartIndexintGets the start index of the characters.
LengthintGets the length of the characters.
FontFontReturns the font of this object.
TextOptionsTextOptionsReturns the text options.

Methods

NameDescription
equalsDetermine whether the current equation node is equal to the specified node
toLaTeX
toMathML
addChildInsert a node of the specified type at the end of the child node list of the current node.
insertChildInserts a node of the specified type at the specified index position in the current node’s child node list.
insertAfterInserts the specified node after the current node.
insertBeforeInserts the specified node before the current node.
getChildReturns the node at the specified index among the children of the current node.
removeRemoves itself from the parent.
removeChildRemoves the specified node from the current node’s children.
removeAllChildrenRemoves all the child nodes of the current node.
setWordArtStyleSets the preset WordArt style.

Only for the text of shape/chart. |

NaryEquationNode.IsHideSubscript property

Whether to display the lower bound

Type: boolean

NaryEquationNode.IsHideSuperscript property

Whether to display the upper bound

Type: boolean

NaryEquationNode.LimitLocation property

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. The value of the property is EquationLimitLocationType integer constant.

Type: int

NaryEquationNode.NaryOperator property

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. It should be noted that this property only accepts one character, and if multiple characters are passed in, only the first character is accepted.

Type: String

NaryEquationNode.NaryOperatorType property

an n-ary operator.e.g “∑” The value of the property is EquationMathematicalOperatorType integer constant.

Type: int

NaryEquationNode.NaryGrow property

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.

Type: boolean

NaryEquationNode.ParentNode property

Specifies the parent node of the current node

Type: EquationNode

NaryEquationNode.Type property

Represents the type of the node. The value of the property is TextNodeType integer constant.

Type: int

NaryEquationNode.EquationType property

Get the equation type of the current node The value of the property is EquationNodeType integer constant.

Type: int

NaryEquationNode.StartIndex property

Gets the start index of the characters.

Type: int

NaryEquationNode.Length property

Gets the length of the characters.

Type: int

NaryEquationNode.Font property

Returns the font of this object.

Type: Font

NaryEquationNode.TextOptions property

Returns the text options.

Type: TextOptions

equals(obj)

Determine whether the current equation node is equal to the specified node

ParameterTypeDescription
objObjectThe specified node

toLaTeX()

toMathML()

addChild(equationType) (1 of 2)

Insert a node of the specified type at the end of the child node list of the current node.

ParameterTypeDescription
equationTypeintA EquationNodeType value. 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(node) (2 of 2)

Inserts the specified node at the end of the current node’s list of child nodes.

ParameterTypeDescription
nodeEquationNodeThe specified node

insertChild(index, equationType)

Inserts a node of the specified type at the specified index position in the current node’s child node list.

ParameterTypeDescription
indexintindex value
equationTypeintA EquationNodeType value. 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(equationType)

Inserts the specified node after the current node.

ParameterTypeDescription
equationTypeintA EquationNodeType value. 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(equationType)

Inserts the specified node before the current node.

ParameterTypeDescription
equationTypeintA EquationNodeType value. 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(index)

Returns the node at the specified index among the children of the current node.

ParameterTypeDescription
indexintIndex of the node

Returns: Returns the corresponding node if the specified node exists, otherwise returns null.

remove()

Removes itself from the parent.

removeChild(node) (1 of 2)

Removes the specified node from the current node’s children.

ParameterTypeDescription
nodeEquationNodeNode to be deleted.

removeChild(index) (2 of 2)

Removes the node at the specified index from the current node’s children.

ParameterTypeDescription
indexintIndex of the node

removeAllChildren()

Removes all the child nodes of the current node.

setWordArtStyle(style)

Sets the preset WordArt style.

Only for the text of shape/chart.

ParameterTypeDescription
styleintA PresetWordArtStyle value. The preset WordArt style.