aspose.cells

Class NaryEquationNode

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

Property Getters/Setters Summary
functiongetEquationType()
Get the equation type of the current node The value of the property is EquationNodeType integer constant.
functiongetFont()
Returns the font of this object.
functionisHideSubscript()
function
           Whether to display the lower bound
functionisHideSuperscript()
function
           Whether to display the upper bound
functiongetLength()
Gets the length of the characters.
functiongetLimitLocation()
function
           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.
functiongetNaryGrow()
function
           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.
functiongetNaryOperator()
function
           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.
functiongetNaryOperatorType()
function
           an n-ary operator.e.g "∑" The value of the property is EquationMathematicalOperatorType integer constant.
functiongetParentNode()
function
           Specifies the parent node of the current node
functiongetStartIndex()
Gets the start index of the characters.
functiongetTextOptions()
Returns the text options.
functiongetType()
Represents the type of the node. The value of the property is TextNodeType integer constant.
 
Method Summary
functionaddChild(node)
Inserts the specified node at the end of the current node's list of child nodes.
functionaddChild(equationType)
Insert a node of the specified type at the end of the child node list of the current node.
functionequals(obj)
Determine whether the current equation node is equal to the specified node
functiongetChild(index)
Returns the node at the specified index among the children of the current node.
functioninsertAfter(equationType)
Inserts the specified node after the current node.
functioninsertBefore(equationType)
Inserts the specified node before the current node.
functioninsertChild(index, equationType)
Inserts a node of the specified type at the specified index position in the current node's child node list.
functionremove()
Removes itself from the parent.
functionremoveAllChildren()
Removes all the child nodes of the current node.
functionremoveChild(node)
Removes the specified node from the current node's children.
functionremoveChild(index)
Removes the node at the specified index from the current node's children.
functionsetWordArtStyle(style)
Sets the preset WordArt style.
 

    • Property Getters/Setters Detail

      • isHideSubscript/setHideSubscript : boolean 

        function isHideSubscript() / function setHideSubscript(value)
        
        Whether to display the lower bound
      • isHideSuperscript/setHideSuperscript : boolean 

        function isHideSuperscript() / function setHideSuperscript(value)
        
        Whether to display the upper bound
      • getLimitLocation/setLimitLocation : Number 

        function getLimitLocation() / function setLimitLocation(value)
        
        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.
      • getNaryOperator/setNaryOperator : String 

        function getNaryOperator() / function setNaryOperator(value)
        
        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.
      • getNaryOperatorType/setNaryOperatorType : Number 

        function getNaryOperatorType() / function setNaryOperatorType(value)
        
        an n-ary operator.e.g "∑" The value of the property is EquationMathematicalOperatorType integer constant.
      • getNaryGrow/setNaryGrow : boolean 

        function getNaryGrow() / function setNaryGrow(value)
        
        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.
      • getParentNode/setParentNode : EquationNode 

        function getParentNode() / function setParentNode(value)
        
        Specifies the parent node of the current node
      • getType : Number 

        function getType()
        
        Represents the type of the node. The value of the property is TextNodeType integer constant.
      • getEquationType : Number 

        function getEquationType()
        
        Get the equation type of the current node The value of the property is EquationNodeType integer constant.
      • getStartIndex : Number 

        function getStartIndex()
        
        Gets the start index of the characters.
      • getLength : Number 

        function getLength()
        
        Gets the length of the characters.
      • getFont : Font 

        function getFont()
        
        Returns the font of this object.
      • getTextOptions : TextOptions 

        function getTextOptions()
        
        Returns the text options.
    • Method Detail

      • equals

        function equals(obj)
        Determine whether the current equation node is equal to the specified node
        Parameters:
        obj: Object - The specified node
        Returns:
      • addChild

        function addChild(equationType)
        Insert a node of the specified type at the end of the child node list of the current node.
        Parameters:
        equationType: Number - A 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

        function addChild(node)
        Inserts the specified node at the end of the current node's list of child nodes.
        Parameters:
        node: EquationNode - The specified node
      • insertChild

        function insertChild(index, equationType)
        Inserts a node of the specified type at the specified index position in the current node's child node list.
        Parameters:
        index: Number - index value
        equationType: Number - A 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

        function insertAfter(equationType)
        Inserts the specified node after the current node.
        Parameters:
        equationType: Number - A 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

        function insertBefore(equationType)
        Inserts the specified node before the current node.
        Parameters:
        equationType: Number - A 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

        function getChild(index)
        Returns the node at the specified index among the children of the current node.
        Parameters:
        index: Number - Index of the node
        Returns:
        Returns the corresponding node if the specified node exists, otherwise returns null.
      • remove

        function remove()
        Removes itself from the parent.
      • removeChild

        function removeChild(node)
        Removes the specified node from the current node's children.
        Parameters:
        node: EquationNode - Node to be deleted.
      • removeChild

        function removeChild(index)
        Removes the node at the specified index from the current node's children.
        Parameters:
        index: Number - Index of the node
      • removeAllChildren

        function removeAllChildren()
        Removes all the child nodes of the current node.
      • setWordArtStyle

        function setWordArtStyle(style)
        Sets the preset WordArt style. Only for the text of shape/chart.
        Parameters:
        style: Number - A PresetWordArtStyle value. The preset WordArt style.