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.
class GroupCharacterEquationNode extends EquationNode;
Constructors
Name | Description |
---|---|
constructor(EquationNode) | Constructs from a parent object convertible to this. |
Properties
Property | Type | Description |
---|---|---|
groupChr | string | 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. |
chrType | EquationCombiningCharacterType | Specify combining characters by type value. |
position | EquationCharacterPositionType | This attribute specifies the position of the character in the object |
vertJc | EquationCharacterPositionType | 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. |
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 |
---|---|
setWordArtStyle(PresetWordArtStyle) | Sets the preset WordArt style. |
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(VObject) | 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. |
groupChr
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.
groupChr : 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.
chrType
Specify combining characters by type value.
chrType : EquationCombiningCharacterType;
position
This attribute specifies the position of the character in the object
position : EquationCharacterPositionType;
vertJc
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.
vertJc : EquationCharacterPositionType;
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;
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.
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(VObject)
Determine whether the current equation node is equal to the specified node
equals(obj: VObject) : boolean;
Parameters:
Parameter | Type | Description |
---|---|---|
obj | VObject | The specified node |
getType()
Represents the type of the node.
getType() : TextNodeType;
Returns