GroupCharacterEquationNode
GroupCharacterEquationNode class
This class specifies the Group-Character function, consisting of a character drawn above or below text, often with the purpose of visually grouping items.
Methods
| Name | Description |
|---|---|
| addChild(equationType) | Insert a node of the specified type at the end of the child node list of the current node. |
| addChild(node) | Inserts the specified node at the end of the current node’s list of child nodes. |
| equals(obj) | Determine whether the current equation node is equal to the specified node |
| getChild(index) | Returns the node at the specified index among the children of the current node. |
| getChrType() | Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant |
| getEquationType() | Get the equation type of the current node The value of the property is EquationNodeType integer constant. |
| getFont() | Returns the font of this object. |
| getGroupChr() | Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. Use thi |
| getLength() | Gets the length of the characters. |
| getParentNode() | Specifies the parent node of the current node |
| getPosition() | This attribute specifies the position of the character in the object The value of the property is EquationCharacterPosit |
| getStartIndex() | Gets the start index of the characters. |
| getTextOptions() | Returns the text options. |
| getType() | Represents the type of the node. The value of the property is TextNodeType integer constant. |
| getVertJc() | This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifi |
| insertAfter(equationType) | Inserts the specified node after the current node. |
| insertBefore(equationType) | Inserts the specified node before the current node. |
| insertChild(index, equationType) | Inserts a node of the specified type at the specified index position in the current node’s child node list. |
| remove() | Removes itself from the parent. |
| removeAllChildren() | Removes all the child nodes of the current node. |
| removeChild(node) | Removes the specified node from the current node’s children. |
| removeChild(index) | Removes the node at the specified index from the current node’s children. |
| setChrType() | Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant |
| setGroupChr() | Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. Use thi |
| setParentNode() | Specifies the parent node of the current node |
| setPosition() | This attribute specifies the position of the character in the object The value of the property is EquationCharacterPosit |
| setVertJc() | This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifi |
| setWordArtStyle(style) | Sets the preset WordArt style. Only for the text of shape/chart. |
| toLaTeX() | |
| toMathML() |
addChild(equationType)
Insert a node of the specified type at the end of the child node list of the current node.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | EquationNodeType |
Returns: EquationNode — EquationNode 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)
Inserts the specified node at the end of the current node’s list of child nodes.
| Parameter | Type | Description |
|---|---|---|
| node | EquationNode | The specified node |
equals(obj)
Determine whether the current equation node is equal to the specified node
| Parameter | Type | Description |
|---|---|---|
| obj | Object | The specified node |
Returns: boolean — boolean
getChild(index)
Returns the node at the specified index among the children of the current node.
| Parameter | Type | Description |
|---|---|---|
| index | Number | Index of the node |
Returns: EquationNode — EquationNode Returns the corresponding node if the specified node exists, otherwise returns null.
getChrType()
Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant.
getEquationType()
Get the equation type of the current node The value of the property is EquationNodeType integer constant.
getFont()
Returns the font of this object.
getGroupChr()
Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. 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.
getLength()
Gets the length of the characters.
getParentNode()
Specifies the parent node of the current node
getPosition()
This attribute specifies the position of the character in the object The value of the property is EquationCharacterPositionType integer constant.
getStartIndex()
Gets the start index of the characters.
getTextOptions()
Returns the text options.
getType()
Represents the type of the node. The value of the property is TextNodeType integer constant.
getVertJc()
This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. The value of the property is EquationCharacterPositionType integer constant.
insertAfter(equationType)
Inserts the specified node after the current node.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | EquationNodeType |
Returns: EquationNode — EquationNode 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.
| Parameter | Type | Description |
|---|---|---|
| equationType | Number | EquationNodeType |
Returns: EquationNode — EquationNode If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
insertChild(index, equationType)
Inserts a node of the specified type at the specified index position in the current node’s child node list.
| Parameter | Type | Description |
|---|---|---|
| index | Number | index value |
| equationType | Number | EquationNodeType |
Returns: EquationNode — EquationNode If the specified type exists, the corresponding node is returned, and if the type does not exist, a node of unknown type is returned.
remove()
Removes itself from the parent.
removeAllChildren()
Removes all the child nodes of the current node.
removeChild(node)
Removes the specified node from the current node’s children.
| Parameter | Type | Description |
|---|---|---|
| node | EquationNode | Node to be deleted. |
removeChild(index)
Removes the node at the specified index from the current node’s children.
| Parameter | Type | Description |
|---|---|---|
| index | Number | Index of the node |
setChrType()
Specify combining characters by type value. The value of the property is EquationCombiningCharacterType integer constant.
setGroupChr()
Specifies a symbol(default U+23DF). It is strongly recommended to use attribute ChrType to set accent character. 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.
setParentNode()
Specifies the parent node of the current node
setPosition()
This attribute specifies the position of the character in the object The value of the property is EquationCharacterPositionType integer constant.
setVertJc()
This attribute, combined with pos of groupChrPr, specifies the vertical layout of the groupChr object. Where pos specifies the position of the grouping character, vertJc specifies the alignment of the object with respect to the baseline. The value of the property is EquationCharacterPositionType integer constant.
setWordArtStyle(style)
Sets the preset WordArt style. Only for the text of shape/chart.
| Parameter | Type | Description |
|---|---|---|
| style | Number | PresetWordArtStyle |