com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IMathElement

    • Method Detail

      • join

        IMathBlock join(IMathElement mathElement)

        Joins a mathematical element and forms a mathematical block


        Example:
         
         IMathElement element1 = new MathematicalText("x");
         IMathElement element2 = new MathematicalText("y");
         IMathBlock block = element1.join(element2);
         
        Parameters:
        mathElement - The element to be joined
        Returns:
        A new IMathBlock containing this instance and specified argument
      • join

        IMathBlock join(java.lang.String mathText)

        Joins a mathematical text and forms a mathematical block


        Example:
         
         IMathElement element = new MathematicalText("x");
         IMathBlock block = element.join("+y");
         
        Parameters:
        mathText - Mathematical text to be joined
        Returns:
        A new IMathBlock containing this instance and specified argument
      • divide

        IMathFraction divide(IMathElement denominator)

        Creates a fraction with this numerator and specified denominator


        Example:
         
         IMathElement numerator = new MathematicalText("x");
         IMathElement denumerator = new MathematicalText("y");
         IMathFraction fraction = numerator.divide(denumerator);
         
        Parameters:
        denominator - Denominator
        Returns:
        new fraction
      • divide

        IMathFraction divide(java.lang.String denominator)

        Creates a fraction with this numerator and specified denominator


        Example:
         
         IMathElement numerator = new MathematicalText("x");
         IMathFraction fraction = numerator.divide("y");
         
        Parameters:
        denominator - Denominator
        Returns:
        new fraction
      • divide

        IMathFraction divide(IMathElement denominator,
                             int fractionType)

        Creates a fraction of the specified type with this numerator and specified denominator


        Example:
         
         IMathElement numerator = new MathematicalText("x");
         IMathElement denumerator = new MathematicalText("y");
         IMathFraction fraction = numerator.divide(denumerator, MathFractionTypes.Linear);
         
        Parameters:
        denominator - Denominator
        fractionType - Fraction type: Bar, NoBar, Skewed, Linear
        Returns:
        new fraction
      • divide

        IMathFraction divide(java.lang.String denominator,
                             int fractionType)

        Creates a fraction of the specified type with this numerator and specified denominator


        Example:
         
         IMathElement numerator = new MathematicalText("x");
         IMathFraction fraction = numerator.divide("y", MathFractionTypes.Linear);
         
        Parameters:
        denominator - Denominator
        fractionType - Fraction type: Bar, NoBar, Skewed, Linear
        Returns:
        new fraction
      • enclose

        IMathDelimiter enclose()

        Enclose a math element in parenthesis


        Example:
         
         IMathElement element = new MathematicalText("x");
         IMathDelimiter delimiter = element.enclose();
         
        Returns:
        The math element of type IMathDelimiter which includes the parenthesis
      • enclose

        IMathDelimiter enclose(char beginningCharacter,
                               char endingCharacter)

        Encloses this element in specified characters such as parenthesis or another characters as framing


        Example:
         
         IMathElement element = new MathematicalText("x");
         IMathDelimiter delimiter = element.enclose('[', ']');
         
        Parameters:
        beginningCharacter - Beginning character (usually left bracket)
        endingCharacter - Ending character (usually right bracket)
        Returns:
        The math element of type IMathDelimiter which includes specified characters as framing
      • function

        IMathFunction function(IMathElement functionArgument)

        Takes a function of an argument using this instance as the function name


        Example:
         
         IMathElement functionName = new MathematicalText("sin");
         IMathElement functionArg = new MathematicalText("x");
         IMathFunction func = functionName.function(functionArg);
         
        Parameters:
        functionArgument - An argument of the function
        Returns:
        New math element of type IMathFunction
      • function

        IMathFunction function(java.lang.String functionArgument)

        Takes a function of an argument using this instance as the function name


        Example:
         
         IMathElement functionName = new MathematicalText("sin");
         IMathFunction func = functionName.function("x");
         
        Parameters:
        functionArgument - An argument of the function
        Returns:
        New math element of type IMathFunction
      • asArgumentOfFunction

        IMathFunction asArgumentOfFunction(IMathElement functionName)

        Takes specified function using this instance as the argument


        Example:
         
         IMathElement functionName = new MathematicalText("sin");
         IMathElement functionArg = new MathematicalText("x");
         IMathFunction func = functionArg.asArgumentOfFunction(functionName);
         
        Parameters:
        functionName - Function name
        Returns:
        New math element of type IMathFunction
      • asArgumentOfFunction

        IMathFunction asArgumentOfFunction(java.lang.String functionName)

        Takes specified function using this instance as the argument


        Example:
         
         IMathElement functionArg = new MathematicalText("x");
         IMathFunction func = functionArg.asArgumentOfFunction("cos");
         
        Parameters:
        functionName - Function name
        Returns:
        New math element of type IMathFunction
      • asArgumentOfFunction

        IMathFunction asArgumentOfFunction(int functionType)

        Takes specified function using this instance as the argument


        Example:
         
         IMathElement functionArg = new MathematicalText("x");
         IMathFunction func = functionArg.asArgumentOfFunction(MathFunctionsOfOneArgument.ArcSin);
         
        Parameters:
        functionType - One of the common function type of one argument
        Returns:
        New math element of type IMathFunction
      • asArgumentOfFunction

        IMathFunction asArgumentOfFunction(int functionType,
                                           IMathElement additionalArgument)

        Takes specified function using this instance as the argument and specified additional argument


        Example:
         
         IMathElement functionArg = new MathematicalText("x");
         IMathElement logarithmBase = new MathematicalText("5");
         IMathFunction func = functionArg.asArgumentOfFunction(MathFunctionsOfTwoArguments.Log, logarithmBase); // Returns the logarithm of 'x' to the base '5'
         
        Parameters:
        functionType - One of the common function type of two arguments: Log, Lim, Min, Max
        additionalArgument - Additional argument depending on the type of function
        Returns:
        New math element of type IMathFunction
      • asArgumentOfFunction

        IMathFunction asArgumentOfFunction(int functionType,
                                           java.lang.String additionalArgument)

        Takes specified function using this instance as the argument and specified additional argument


        Example:
         
         IMathElement functionArg = new MathematicalText("x");
         IMathFunction func = functionArg.asArgumentOfFunction(MathFunctionsOfTwoArguments.Log, "5"); // Returns the logarithm of 'x' to the base '5'
         
        Parameters:
        functionType - One of the common function type of two arguments: Log, Lim, Min, Max
        additionalArgument - Additional argument depending on the type of function
        Returns:
        New math element of type IMathFunction
      • setSubscript

        IMathSubscriptElement setSubscript(IMathElement subscript)

        Creates subscript


        Example:
         
         IMathElement element = new MathematicalText("N");
         IMathElement index = new MathematicalText("i");
         IMathSubscriptElement subscript = element.setSubscript(index);
         
        Parameters:
        subscript - Subscript (lower index on the right)
        Returns:
        New math element of type IMathSubscriptElement
      • setSubscript

        IMathSubscriptElement setSubscript(java.lang.String subscript)

        Creates subscript


        Example:
         
         IMathElement element = new MathematicalText("N");
         IMathSubscriptElement subscript = element.setSubscript("i");
         
        Parameters:
        subscript - Subscript (lower index on the right)
        Returns:
        New math element of type IMathSubscriptElement
      • setSuperscript

        IMathSuperscriptElement setSuperscript(IMathElement superscript)

        Creates superscript


        Example:
         
         IMathElement element = new MathematicalText("N");
         IMathElement index = new MathematicalText("4");
         IMathSuperscriptElement superscript = element.setSuperscript(index);
         
        Parameters:
        superscript - Superscript (upper index on the right)
        Returns:
        New math element of type IMathSuperscriptElement
      • setSuperscript

        IMathSuperscriptElement setSuperscript(java.lang.String superscript)

        Creates superscript


        Example:
         
         IMathElement element = new MathematicalText("N");
         IMathSuperscriptElement superscript = element.setSuperscript("4");
         
        Parameters:
        superscript - Superscript (upper index on the right)
        Returns:
        New math element of type IMathSuperscriptElement
      • setSubSuperscriptOnTheRight

        IMathRightSubSuperscriptElement setSubSuperscriptOnTheRight(IMathElement subscript,
                                                                    IMathElement superscript)

        Creates subscript and superscript on the right


        Example:
         
         IMathElement baseElement = new MathematicalText("N");
         IMathElement subscript = new MathematicalText("i");
         IMathElement superscript = new MathematicalText("j");
         IMathRightSubSuperscriptElement subsuperscript = baseElement.setSubSuperscriptOnTheRight(subscript, superscript);
         
        Parameters:
        subscript - Subscript (lower index on the right)
        superscript - Superscript (upper index on the right)
        Returns:
        New math element of type IMathRightSubSuperscriptElement
      • setSubSuperscriptOnTheRight

        IMathRightSubSuperscriptElement setSubSuperscriptOnTheRight(java.lang.String subscript,
                                                                    java.lang.String superscript)

        Creates subscript and superscript on the right


        Example:
         
         IMathElement baseElement = new MathematicalText("N");
         IMathRightSubSuperscriptElement subsuperscript = baseElement.setSubSuperscriptOnTheRight("i", "j");
         
        Parameters:
        subscript - Subscript (lower index on the right)
        superscript - Superscript (upper index on the right)
        Returns:
        New math element of type IMathRightSubSuperscriptElement
      • setSubSuperscriptOnTheLeft

        IMathLeftSubSuperscriptElement setSubSuperscriptOnTheLeft(IMathElement subscript,
                                                                  IMathElement superscript)

        Creates subscript and superscript on the left


        Example:
         
         IMathElement baseElement = new MathematicalText("N");
         IMathElement subscript = new MathematicalText("i");
         IMathElement superscript = new MathematicalText("j");
         IMathLeftSubSuperscriptElement leftSubsuperscript = baseElement.setSubSuperscriptOnTheLeft(subscript, superscript);
         
        Parameters:
        subscript - Subscript (lower index on the left)
        superscript - Superscript (upper index on the left)
        Returns:
        New math element of type IMathLeftSubSuperscriptElement
      • setSubSuperscriptOnTheLeft

        IMathLeftSubSuperscriptElement setSubSuperscriptOnTheLeft(java.lang.String subscript,
                                                                  java.lang.String superscript)

        Creates subscript and superscript on the left


        Example:
         
         IMathElement baseElement = new MathematicalText("N");
         IMathLeftSubSuperscriptElement leftSubsuperscript = baseElement.setSubSuperscriptOnTheLeft("i", "j");
         
        Parameters:
        subscript - Subscript (lower index on the left)
        superscript - Superscript (upper index on the left)
        Returns:
        New math element of type IMathLeftSubSuperscriptElement
      • radical

        IMathRadical radical(IMathElement degree)

        Specifies the mathematical root of the given degree from the specified argument.


        Example:
         
         IMathElement baseElement = new MathematicalText("2px");
         IMathElement degree = new MathematicalText("y");
         IMathRadical radical = baseElement.radical(degree);
         
        Parameters:
        degree - Argument of Radical
        Returns:
        New instance of type IMathRadical
      • radical

        IMathRadical radical(java.lang.String degree)

        Specifies the mathematical root of the given degree from the specified argument.


        Example:
         
         IMathElement baseElement = new MathematicalText("2px");
         IMathRadical radical = baseElement.radical("3");
         
        Parameters:
        degree - Argument of Radical
        Returns:
        New instance of type IMathRadical
      • setUpperLimit

        IMathLimit setUpperLimit(IMathElement limit)

        Takes upper limit


        Example:
         
         IMathElement baseElement = new MathematicalText("y");
         IMathElement limitValue = new MathematicalText("y−>1");
         IMathLimit limitElement = baseElement.setUpperLimit(limitValue);
         
        Parameters:
        limit - limit
        Returns:
        New instance of type IMathLimit
      • setUpperLimit

        IMathLimit setUpperLimit(java.lang.String limit)

        Takes upper limit


        Example:
         
         IMathElement baseElement = new MathematicalText("y");
         IMathLimit limitElement = baseElement.setUpperLimit("y−>1");
         
        Parameters:
        limit - limit
        Returns:
        New instance of type IMathLimit
      • setLowerLimit

        IMathLimit setLowerLimit(IMathElement limit)

        Takes lower limit


        Example:
         
         IMathElement baseElement = new MathematicalText("lim");
         IMathElement limitValue = new MathematicalText("𝑛→∞");
         IMathLimit limitElement = baseElement.setLowerLimit(limitValue);
         
        Parameters:
        limit - limit
        Returns:
        New instance of type IMathLimit
      • setLowerLimit

        IMathLimit setLowerLimit(java.lang.String limit)

        Takes lower limit


        Example:
         
         IMathElement baseElement = new MathematicalText("lim");
         IMathLimit limitElement = baseElement.setLowerLimit("𝑛→∞");
         
        Parameters:
        limit - limit
        Returns:
        New instance of type IMathLimit
      • nary

        IMathNaryOperator nary(int type,
                               IMathElement lowerLimit,
                               IMathElement upperLimit)

        Creates a N-ary operator


        Example:
         
         IMathElement baseElement = new MathematicalText("i-1");
         IMathElement lowerLimit = new MathematicalText("i=0");
         IMathElement upperLimit = new MathematicalText("𝑛");
         IMathNaryOperator naryOperator = baseElement.nary(MathNaryOperatorTypes.Summation, lowerLimit, upperLimit);
         
        Parameters:
        type - The N-ary operator type
        lowerLimit - The lower limit
        upperLimit - The upper limit
        Returns:
        New instance of type IMathNaryOperator
      • nary

        IMathNaryOperator nary(int type,
                               java.lang.String lowerLimit,
                               java.lang.String upperLimit)

        Creates a N-ary operator


        Example:
         
         IMathNaryOperator naryOperator = new MathematicalText("i").nary(MathNaryOperatorTypes.Summation, "i=0", "𝑛");
         
        Parameters:
        type - The N-ary operator type
        lowerLimit - The lower limit
        upperLimit - The upper limit
        Returns:
        New instance of type IMathNaryOperator
      • toMathArray

        IMathArray toMathArray()

        Puts in a vertical array


        Example:
         
         IMathArray array = new MathematicalText("x1").join("x2").join("x3").toMathArray();
         
        Returns:
        New instance of type IMathArray
      • integral

        IMathNaryOperator integral(int integralType,
                                   IMathElement lowerLimit,
                                   IMathElement upperLimit,
                                   int limitLocations)

        Takes the integral


        Example:
         
         IMathElement baseElement = new MathematicalText("𝑥");
         IMathElement lowerLimit = new MathematicalText("1");
         IMathElement upperLimit = new MathematicalText("2");
         IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, lowerLimit, upperLimit, MathLimitLocations.UnderOver);
         
        Parameters:
        integralType - Integral type
        lowerLimit - Lower limit of integral
        upperLimit - Upper limit of integral
        limitLocations - location of limits
        Returns:
        New instance of type IMathNaryOperator
      • integral

        IMathNaryOperator integral(int integralType,
                                   IMathElement lowerLimit,
                                   IMathElement upperLimit)

        Takes the integral


        Example:
         
         IMathElement baseElement = new MathematicalText("𝑥");
         IMathElement lowerLimit = new MathematicalText("1");
         IMathElement upperLimit = new MathematicalText("2");
         IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, lowerLimit, upperLimit, MathLimitLocations.UnderOver);
         
        Parameters:
        integralType - Integral type
        lowerLimit - Lower limit of integral
        upperLimit - Upper limit of integral
        Returns:
        New instance of type IMathNaryOperator
      • integral

        IMathNaryOperator integral(int integralType)

        Takes the integral without limits


        Example:
         
         IMathElement baseElement = new MathematicalText("𝑥");
         IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Contour);
         
        Parameters:
        integralType - Integral type
        Returns:
        New instance of type IMathNaryOperator
      • integral

        IMathNaryOperator integral(int integralType,
                                   java.lang.String lowerLimit,
                                   java.lang.String upperLimit,
                                   int limitLocations)

        Takes the integral


        Example:
         
         IMathElement baseElement = new MathematicalText("𝑥");
         IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, "1", "5", MathLimitLocations.UnderOver);
         
        Parameters:
        integralType - Integral type
        lowerLimit - Lower limit of integral
        upperLimit - Upper limit of integral
        limitLocations - location of limits
        Returns:
        New instance of type IMathNaryOperator
      • integral

        IMathNaryOperator integral(int integralType,
                                   java.lang.String lowerLimit,
                                   java.lang.String upperLimit)

        Takes the integral


        Example:
         
         IMathElement baseElement = new MathematicalText("𝑥");
         IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, "1", "5");
         
        Parameters:
        integralType - Integral type
        lowerLimit - Lower limit of integral
        upperLimit - Upper limit of integral
        Returns:
        New instance of type IMathNaryOperator
      • accent

        IMathAccent accent(char accentCharacter)

        Sets an accent mark (a character on the top of this element)


        Example:
         
         IMathAccent accent = new MathematicalText("x").accent('~');
         
        Parameters:
        accentCharacter - Accent character. The value should be within the range of (U+0300–U+036F) or (U+20D0–U+20EF)
        Returns:
        New instance of type IMathAccent
      • overbar

        IMathBar overbar()

        Sets a bar on the top of this element


        Example:
         
         IMathBar bar = new MathematicalText("x").overbar();
         
        Returns:
        New instance of type IMathBar
      • underbar

        IMathBar underbar()

        Sets a bar on the bottom of this element


        Example:
         
         IMathBar bar = new MathematicalText("x").underbar();
         
        Returns:
        New instance of type IMathBar
      • group

        IMathGroupingCharacter group()

        Places this element in a group using a bottom curly bracket


        Example:
         
         IMathGroupingCharacter groupingElement = new MathematicalText("x;y;z").group();
         
        Returns:
        New instance of type IMathGroupingCharacter
      • group

        IMathGroupingCharacter group(char character,
                                     int position,
                                     int verticalJustification)

        Places this element in a group using a grouping character such as bottom curly bracket or another


        Example:
         
         IMathGroupingCharacter groupingElement = new MathematicalText("x;y;z").group('⏡', MathTopBotPositions.Bottom, MathTopBotPositions.Top);
         
        Parameters:
        character - Grouping Character such as BOTTOM CURLY BRACKET (U+23DF) or any other
        position - Position of grouping character
        verticalJustification - Vertical justification of group character. Specifies the alignment of the object with respect to the baseline. For example, when the group character is above the object, VerticalJustification of Top signifies that the top of the object falls on the baseline; when VerticalJustification is set to Bottom, the bottom of the object is on the baseline
        Returns:
        New instance of type IMathGroupingCharacter
      • toBorderBox

        IMathBorderBox toBorderBox()

        Places this element in a border-box


        Example:
         
         IMathBorderBox borderBox = new MathematicalText("x+y+z").toBorderBox();
         
        Returns:
        Border-box with this element placed inside
      • toBorderBox

        IMathBorderBox toBorderBox(boolean hideTop,
                                   boolean hideBottom,
                                   boolean hideLeft,
                                   boolean hideRight,
                                   boolean strikethroughHorizontal,
                                   boolean strikethroughVertical,
                                   boolean strikethroughBottomLeftToTopRight,
                                   boolean strikethroughTopLeftToBottomRight)

        Places this element in a border-box


        Example:
         
         IMathBorderBox borderBox = new MathematicalText("x+y+z").toBorderBox(false, false, true, true, false, false, false, false);
         
        Parameters:
        hideTop - Hide Top Edge
        hideBottom - Hide Bottom Edge
        hideLeft - Hide Left Edge
        hideRight - Hide Right Edge
        strikethroughHorizontal - Border Box Strikethrough Horizontal
        strikethroughVertical - Border Box Strikethrough Vertical
        strikethroughBottomLeftToTopRight - Border Box Strikethrough Bottom-Left to Top-Right
        strikethroughTopLeftToBottomRight - Border Box Strikethrough Top-Left to Bottom-Right
        Returns:
        Border-box with this element placed inside
      • toBox

        IMathBox toBox()

        Places this element in a non-visual box (logical grouping) which is used to group components of an equation or other instance of mathematical text. A boxed object can (for example) serve as an operator emulator with or without an alignment point, serve as a line break point, or be grouped such as not to allow line breaks within.


        Example:
         
         IMathBox box = new MathematicalText("x:=y").toBox();
         
        Returns:
        Logical box with this element placed inside