IMathElement
public interface IMathElement
Base interface of any mathematical element: fraction, mathmatical text, function, expression with multiple elements etc
Example: IMathElement element = new MathematicalText("x");
Methods
| Method | Description |
|---|---|
| getChildren() | Get children elements |
| join(IMathElement mathElement) | Joins a mathematical element and forms a mathematical block |
| join(String mathText) | Joins a mathematical text and forms a mathematical block |
| divide(IMathElement denominator) | Creates a fraction with this numerator and specified denominator |
| divide(String denominator) | Creates a fraction with this numerator and specified denominator |
| divide(IMathElement denominator, int fractionType) | Creates a fraction of the specified type with this numerator and specified denominator |
| divide(String denominator, int fractionType) | Creates a fraction of the specified type with this numerator and specified denominator |
| enclose() | Enclose a math element in parenthesis |
| enclose(char beginningCharacter, char endingCharacter) | Encloses this element in specified characters such as parenthesis or another characters as framing |
| function(IMathElement functionArgument) | Takes a function of an argument using this instance as the function name |
| function(String functionArgument) | Takes a function of an argument using this instance as the function name |
| asArgumentOfFunction(IMathElement functionName) | Takes specified function using this instance as the argument |
| asArgumentOfFunction(String functionName) | Takes specified function using this instance as the argument |
| asArgumentOfFunction(int functionType) | Takes specified function using this instance as the argument |
| asArgumentOfFunction(int functionType, IMathElement additionalArgument) | Takes specified function using this instance as the argument and specified additional argument |
| asArgumentOfFunction(int functionType, String additionalArgument) | Takes specified function using this instance as the argument and specified additional argument |
| setSubscript(IMathElement subscript) | Creates subscript |
| setSubscript(String subscript) | Creates subscript |
| setSuperscript(IMathElement superscript) | Creates superscript |
| setSuperscript(String superscript) | Creates superscript |
| setSubSuperscriptOnTheRight(IMathElement subscript, IMathElement superscript) | Creates subscript and superscript on the right |
| setSubSuperscriptOnTheRight(String subscript, String superscript) | Creates subscript and superscript on the right |
| setSubSuperscriptOnTheLeft(IMathElement subscript, IMathElement superscript) | Creates subscript and superscript on the left |
| setSubSuperscriptOnTheLeft(String subscript, String superscript) | Creates subscript and superscript on the left |
| radical(IMathElement degree) | Specifies the mathematical root of the given degree from the specified argument. |
| radical(String degree) | Specifies the mathematical root of the given degree from the specified argument. |
| setUpperLimit(IMathElement limit) | Takes upper limit |
| setUpperLimit(String limit) | Takes upper limit |
| setLowerLimit(IMathElement limit) | Takes lower limit |
| setLowerLimit(String limit) | Takes lower limit |
| nary(int type, IMathElement lowerLimit, IMathElement upperLimit) | Creates a N-ary operator |
| nary(int type, String lowerLimit, String upperLimit) | Creates a N-ary operator |
| toMathArray() | Puts in a vertical array |
| integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit, int limitLocations) | Takes the integral |
| integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit) | Takes the integral |
| integral(int integralType) | Takes the integral without limits |
| integral(int integralType, String lowerLimit, String upperLimit, int limitLocations) | Takes the integral |
| integral(int integralType, String lowerLimit, String upperLimit) | Takes the integral |
| accent(char accentCharacter) | Sets an accent mark (a character on the top of this element) |
| overbar() | Sets a bar on the top of this element |
| underbar() | Sets a bar on the bottom of this element |
| group() | Places this element in a group using a bottom curly bracket |
| group(char character, int position, int verticalJustification) | Places this element in a group using a grouping character such as bottom curly bracket or another |
| toBorderBox() | Places this element in a border-box |
| toBorderBox(boolean hideTop, boolean hideBottom, boolean hideLeft, boolean hideRight, boolean strikethroughHorizontal, boolean strikethroughVertical, boolean strikethroughBottomLeftToTopRight, boolean strikethroughTopLeftToBottomRight) | Places this element in a border-box |
| 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. |
getChildren()
public abstract IMathElement[] getChildren()
Get children elements
Returns: com.aspose.slides.IMathElement[]
join(IMathElement mathElement)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| mathElement | IMathElement | The element to be joined |
Returns: IMathBlock - A new IMathBlock containing this instance and specified argument
join(String mathText)
public abstract IMathBlock join(String mathText)
Joins a mathematical text and forms a mathematical block
Example: IMathElement element = new MathematicalText("x"); IMathBlock block = element.join("+y");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| mathText | java.lang.String | Mathematical text to be joined |
Returns: IMathBlock - A new IMathBlock containing this instance and specified argument
divide(IMathElement denominator)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| denominator | IMathElement | Denominator |
Returns: IMathFraction - new fraction
divide(String denominator)
public abstract IMathFraction divide(String denominator)
Creates a fraction with this numerator and specified denominator
Example: IMathElement numerator = new MathematicalText("x"); IMathFraction fraction = numerator.divide("y");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| denominator | java.lang.String | Denominator |
Returns: IMathFraction - new fraction
divide(IMathElement denominator, int fractionType)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| denominator | IMathElement | Denominator |
| fractionType | int | Fraction type: Bar, NoBar, Skewed, Linear |
Returns: IMathFraction - new fraction
divide(String denominator, int fractionType)
public abstract IMathFraction divide(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:
| Parameter | Type | Description |
|---|---|---|
| denominator | java.lang.String | Denominator |
| fractionType | int | Fraction type: Bar, NoBar, Skewed, Linear |
Returns: IMathFraction - new fraction
enclose()
public abstract IMathDelimiter enclose()
Enclose a math element in parenthesis
Example: IMathElement element = new MathematicalText("x"); IMathDelimiter delimiter = element.enclose();
Returns: IMathDelimiter - The math element of type IMathDelimiter which includes the parenthesis
enclose(char beginningCharacter, char endingCharacter)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| beginningCharacter | char | Beginning character (usually left bracket) |
| endingCharacter | char | Ending character (usually right bracket) |
Returns: IMathDelimiter - The math element of type IMathDelimiter which includes specified characters as framing
function(IMathElement functionArgument)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| functionArgument | IMathElement | An argument of the function |
Returns: IMathFunction - New math element of type IMathFunction
function(String functionArgument)
public abstract IMathFunction function(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:
| Parameter | Type | Description |
|---|---|---|
| functionArgument | java.lang.String | An argument of the function |
Returns: IMathFunction - New math element of type IMathFunction
asArgumentOfFunction(IMathElement functionName)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| functionName | IMathElement | Function name |
Returns: IMathFunction - New math element of type IMathFunction
asArgumentOfFunction(String functionName)
public abstract IMathFunction asArgumentOfFunction(String functionName)
Takes specified function using this instance as the argument
Example: IMathElement functionArg = new MathematicalText("x"); IMathFunction func = functionArg.asArgumentOfFunction("cos");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| functionName | java.lang.String | Function name |
Returns: IMathFunction - New math element of type IMathFunction
asArgumentOfFunction(int functionType)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| functionType | int | One of the common function type of one argument |
Returns: IMathFunction - New math element of type IMathFunction
asArgumentOfFunction(int functionType, IMathElement additionalArgument)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| functionType | int | One of the common function type of two arguments: Log, Lim, Min, Max |
| additionalArgument | IMathElement | Additional argument depending on the type of function |
Returns: IMathFunction - New math element of type IMathFunction
asArgumentOfFunction(int functionType, String additionalArgument)
public abstract IMathFunction asArgumentOfFunction(int functionType, 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:
| Parameter | Type | Description |
|---|---|---|
| functionType | int | One of the common function type of two arguments: Log, Lim, Min, Max |
| additionalArgument | java.lang.String | Additional argument depending on the type of function |
Returns: IMathFunction - New math element of type IMathFunction
setSubscript(IMathElement subscript)
public abstract IMathSubscriptElement setSubscript(IMathElement subscript)
Creates subscript
Example: IMathElement element = new MathematicalText("N"); IMathElement index = new MathematicalText("i"); IMathSubscriptElement subscript = element.setSubscript(index);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subscript | IMathElement | Subscript (lower index on the right) |
Returns: IMathSubscriptElement - New math element of type IMathSubscriptElement
setSubscript(String subscript)
public abstract IMathSubscriptElement setSubscript(String subscript)
Creates subscript
Example: IMathElement element = new MathematicalText("N"); IMathSubscriptElement subscript = element.setSubscript("i");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subscript | java.lang.String | Subscript (lower index on the right) |
Returns: IMathSubscriptElement - New math element of type IMathSubscriptElement
setSuperscript(IMathElement superscript)
public abstract IMathSuperscriptElement setSuperscript(IMathElement superscript)
Creates superscript
Example: IMathElement element = new MathematicalText("N"); IMathElement index = new MathematicalText("4"); IMathSuperscriptElement superscript = element.setSuperscript(index);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| superscript | IMathElement | Superscript (upper index on the right) |
Returns: IMathSuperscriptElement - New math element of type IMathSuperscriptElement
setSuperscript(String superscript)
public abstract IMathSuperscriptElement setSuperscript(String superscript)
Creates superscript
Example: IMathElement element = new MathematicalText("N"); IMathSuperscriptElement superscript = element.setSuperscript("4");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| superscript | java.lang.String | Superscript (upper index on the right) |
Returns: IMathSuperscriptElement - New math element of type IMathSuperscriptElement
setSubSuperscriptOnTheRight(IMathElement subscript, IMathElement superscript)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| subscript | IMathElement | Subscript (lower index on the right) |
| superscript | IMathElement | Superscript (upper index on the right) |
Returns: IMathRightSubSuperscriptElement - New math element of type IMathRightSubSuperscriptElement
setSubSuperscriptOnTheRight(String subscript, String superscript)
public abstract IMathRightSubSuperscriptElement setSubSuperscriptOnTheRight(String subscript, String superscript)
Creates subscript and superscript on the right
Example: IMathElement baseElement = new MathematicalText("N"); IMathRightSubSuperscriptElement subsuperscript = baseElement.setSubSuperscriptOnTheRight("i", "j");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subscript | java.lang.String | Subscript (lower index on the right) |
| superscript | java.lang.String | Superscript (upper index on the right) |
Returns: IMathRightSubSuperscriptElement - New math element of type IMathRightSubSuperscriptElement
setSubSuperscriptOnTheLeft(IMathElement subscript, IMathElement superscript)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| subscript | IMathElement | Subscript (lower index on the left) |
| superscript | IMathElement | Superscript (upper index on the left) |
Returns: IMathLeftSubSuperscriptElement - New math element of type IMathLeftSubSuperscriptElement
setSubSuperscriptOnTheLeft(String subscript, String superscript)
public abstract IMathLeftSubSuperscriptElement setSubSuperscriptOnTheLeft(String subscript, String superscript)
Creates subscript and superscript on the left
Example: IMathElement baseElement = new MathematicalText("N"); IMathLeftSubSuperscriptElement leftSubsuperscript = baseElement.setSubSuperscriptOnTheLeft("i", "j");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| subscript | java.lang.String | Subscript (lower index on the left) |
| superscript | java.lang.String | Superscript (upper index on the left) |
Returns: IMathLeftSubSuperscriptElement - New math element of type IMathLeftSubSuperscriptElement
radical(IMathElement degree)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| degree | IMathElement | Argument of Radical |
Returns: IMathRadical - New instance of type IMathRadical
radical(String degree)
public abstract IMathRadical radical(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:
| Parameter | Type | Description |
|---|---|---|
| degree | java.lang.String | Argument of Radical |
Returns: IMathRadical - New instance of type IMathRadical
setUpperLimit(IMathElement limit)
public abstract IMathLimit setUpperLimit(IMathElement limit)
Takes upper limit
Example: IMathElement baseElement = new MathematicalText("y"); IMathElement limitValue = new MathematicalText("y\u2212>1"); IMathLimit limitElement = baseElement.setUpperLimit(limitValue);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| limit | IMathElement | limit |
Returns: IMathLimit - New instance of type IMathLimit
setUpperLimit(String limit)
public abstract IMathLimit setUpperLimit(String limit)
Takes upper limit
Example: IMathElement baseElement = new MathematicalText("y"); IMathLimit limitElement = baseElement.setUpperLimit("y\u2212>1");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| limit | java.lang.String | limit |
Returns: IMathLimit - New instance of type IMathLimit
setLowerLimit(IMathElement limit)
public abstract IMathLimit setLowerLimit(IMathElement limit)
Takes lower limit
Example: IMathElement baseElement = new MathematicalText("lim"); IMathElement limitValue = new MathematicalText("\ud835\udc5b\u2192\u221e"); IMathLimit limitElement = baseElement.setLowerLimit(limitValue);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| limit | IMathElement | limit |
Returns: IMathLimit - New instance of type IMathLimit
setLowerLimit(String limit)
public abstract IMathLimit setLowerLimit(String limit)
Takes lower limit
Example: IMathElement baseElement = new MathematicalText("lim"); IMathLimit limitElement = baseElement.setLowerLimit("\ud835\udc5b\u2192\u221e");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| limit | java.lang.String | limit |
Returns: IMathLimit - New instance of type IMathLimit
nary(int type, IMathElement lowerLimit, IMathElement upperLimit)
public abstract 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("\ud835\udc5b"); IMathNaryOperator naryOperator = baseElement.nary(MathNaryOperatorTypes.Summation, lowerLimit, upperLimit);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | The N-ary operator type |
| lowerLimit | IMathElement | The lower limit |
| upperLimit | IMathElement | The upper limit |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
nary(int type, String lowerLimit, String upperLimit)
public abstract IMathNaryOperator nary(int type, String lowerLimit, String upperLimit)
Creates a N-ary operator
Example: IMathNaryOperator naryOperator = new MathematicalText("i").nary(MathNaryOperatorTypes.Summation, "i=0", "\ud835\udc5b");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | The N-ary operator type |
| lowerLimit | java.lang.String | The lower limit |
| upperLimit | java.lang.String | The upper limit |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
toMathArray()
public abstract IMathArray toMathArray()
Puts in a vertical array
Example: IMathArray array = new MathematicalText("x1").join("x2").join("x3").toMathArray();
Returns: IMathArray - New instance of type IMathArray
integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit, int limitLocations)
public abstract IMathNaryOperator integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit, int limitLocations)
Takes the integral
Example: IMathElement baseElement = new MathematicalText("\ud835\udc65"); IMathElement lowerLimit = new MathematicalText("1"); IMathElement upperLimit = new MathematicalText("2"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, lowerLimit, upperLimit, MathLimitLocations.UnderOver);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| integralType | int | Integral type |
| lowerLimit | IMathElement | Lower limit of integral |
| upperLimit | IMathElement | Upper limit of integral |
| limitLocations | int | location of limits |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit)
public abstract IMathNaryOperator integral(int integralType, IMathElement lowerLimit, IMathElement upperLimit)
Takes the integral
Example: IMathElement baseElement = new MathematicalText("\ud835\udc65"); IMathElement lowerLimit = new MathematicalText("1"); IMathElement upperLimit = new MathematicalText("2"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, lowerLimit, upperLimit, MathLimitLocations.UnderOver);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| integralType | int | Integral type |
| lowerLimit | IMathElement | Lower limit of integral |
| upperLimit | IMathElement | Upper limit of integral |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
integral(int integralType)
public abstract IMathNaryOperator integral(int integralType)
Takes the integral without limits
Example: IMathElement baseElement = new MathematicalText("\ud835\udc65"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Contour);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| integralType | int | Integral type |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
integral(int integralType, String lowerLimit, String upperLimit, int limitLocations)
public abstract IMathNaryOperator integral(int integralType, String lowerLimit, String upperLimit, int limitLocations)
Takes the integral
Example: IMathElement baseElement = new MathematicalText("\ud835\udc65"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, "1", "5", MathLimitLocations.UnderOver);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| integralType | int | Integral type |
| lowerLimit | java.lang.String | Lower limit of integral |
| upperLimit | java.lang.String | Upper limit of integral |
| limitLocations | int | location of limits |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
integral(int integralType, String lowerLimit, String upperLimit)
public abstract IMathNaryOperator integral(int integralType, String lowerLimit, String upperLimit)
Takes the integral
Example: IMathElement baseElement = new MathematicalText("\ud835\udc65"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Simple, "1", "5");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| integralType | int | Integral type |
| lowerLimit | java.lang.String | Lower limit of integral |
| upperLimit | java.lang.String | Upper limit of integral |
Returns: IMathNaryOperator - New instance of type IMathNaryOperator
accent(char accentCharacter)
public abstract IMathAccent accent(char accentCharacter)
Sets an accent mark (a character on the top of this element)
Example: IMathAccent accent = new MathematicalText("x").accent('~');
Parameters:
| Parameter | Type | Description |
|---|---|---|
| accentCharacter | char | Accent character. The value should be within the range of (U+0300\u2013U+036F) or (U+20D0\u2013U+20EF) |
Returns: IMathAccent - New instance of type IMathAccent
overbar()
public abstract IMathBar overbar()
Sets a bar on the top of this element
Example: IMathBar bar = new MathematicalText("x").overbar();
Returns: IMathBar - New instance of type IMathBar
underbar()
public abstract IMathBar underbar()
Sets a bar on the bottom of this element
Example: IMathBar bar = new MathematicalText("x").underbar();
Returns: IMathBar - New instance of type IMathBar
group()
public abstract IMathGroupingCharacter group()
Places this element in a group using a bottom curly bracket
Example: IMathGroupingCharacter groupingElement = new MathematicalText("x;y;z").group();
Returns: IMathGroupingCharacter - New instance of type IMathGroupingCharacter
group(char character, int position, int verticalJustification)
public abstract 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('\u23e1', MathTopBotPositions.Bottom, MathTopBotPositions.Top);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| character | char | Grouping Character such as BOTTOM CURLY BRACKET (U+23DF) or any other |
| position | int | Position of grouping character |
| verticalJustification | int | 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: IMathGroupingCharacter - New instance of type IMathGroupingCharacter
toBorderBox()
public abstract IMathBorderBox toBorderBox()
Places this element in a border-box
Example: IMathBorderBox borderBox = new MathematicalText("x+y+z").toBorderBox();
Returns: IMathBorderBox - Border-box with this element placed inside
toBorderBox(boolean hideTop, boolean hideBottom, boolean hideLeft, boolean hideRight, boolean strikethroughHorizontal, boolean strikethroughVertical, boolean strikethroughBottomLeftToTopRight, boolean strikethroughTopLeftToBottomRight)
public abstract 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:
| Parameter | Type | Description |
|---|---|---|
| hideTop | boolean | Hide Top Edge |
| hideBottom | boolean | Hide Bottom Edge |
| hideLeft | boolean | Hide Left Edge |
| hideRight | boolean | Hide Right Edge |
| strikethroughHorizontal | boolean | Border Box Strikethrough Horizontal |
| strikethroughVertical | boolean | Border Box Strikethrough Vertical |
| strikethroughBottomLeftToTopRight | boolean | Border Box Strikethrough Bottom-Left to Top-Right |
| strikethroughTopLeftToBottomRight | boolean | Border Box Strikethrough Top-Left to Bottom-Right |
Returns: IMathBorderBox - Border-box with this element placed inside
toBox()
public abstract 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: IMathBox - Logical box with this element placed inside