public interface IMathElement
Base interface of any mathematical element: fraction, mathmatical text, function, expression with multiple elements etc
Example:IMathElement element = new MathematicalText("x");
Modifier and Type | Method and Description |
---|---|
IMathAccent |
accent(char accentCharacter)
Sets an accent mark (a character on the top of this element)
|
IMathFunction |
asArgumentOfFunction(IMathElement functionName)
Takes specified function using this instance as the argument
|
IMathFunction |
asArgumentOfFunction(int functionType)
Takes specified function using this instance as the argument
|
IMathFunction |
asArgumentOfFunction(int functionType,
IMathElement additionalArgument)
Takes specified function using this instance as the argument and specified additional argument
|
IMathFunction |
asArgumentOfFunction(int functionType,
java.lang.String additionalArgument)
Takes specified function using this instance as the argument and specified additional argument
|
IMathFunction |
asArgumentOfFunction(java.lang.String functionName)
Takes specified function using this instance as the argument
|
IMathFraction |
divide(IMathElement denominator)
Creates a fraction with this numerator and specified denominator
|
IMathFraction |
divide(IMathElement denominator,
int fractionType)
Creates a fraction of the specified type with this numerator and specified denominator
|
IMathFraction |
divide(java.lang.String denominator)
Creates a fraction with this numerator and specified denominator
|
IMathFraction |
divide(java.lang.String denominator,
int fractionType)
Creates a fraction of the specified type with this numerator and specified denominator
|
IMathDelimiter |
enclose()
Enclose a math element in parenthesis
|
IMathDelimiter |
enclose(char beginningCharacter,
char endingCharacter)
Encloses this element in specified characters such as parenthesis or another characters as framing
|
IMathFunction |
function(IMathElement functionArgument)
Takes a function of an argument using this instance as the function name
|
IMathFunction |
function(java.lang.String functionArgument)
Takes a function of an argument using this instance as the function name
|
IMathGroupingCharacter |
group()
Places this element in a group using a bottom curly bracket
|
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
|
IMathNaryOperator |
integral(int integralType)
Takes the integral without limits
|
IMathNaryOperator |
integral(int integralType,
IMathElement lowerLimit,
IMathElement upperLimit)
Takes the integral
|
IMathNaryOperator |
integral(int integralType,
IMathElement lowerLimit,
IMathElement upperLimit,
int limitLocations)
Takes the integral
|
IMathNaryOperator |
integral(int integralType,
java.lang.String lowerLimit,
java.lang.String upperLimit)
Takes the integral
|
IMathNaryOperator |
integral(int integralType,
java.lang.String lowerLimit,
java.lang.String upperLimit,
int limitLocations)
Takes the integral
|
IMathBlock |
join(IMathElement mathElement)
Joins a mathematical element and forms a mathematical block
|
IMathBlock |
join(java.lang.String mathText)
Joins a mathematical text and forms a mathematical block
|
IMathNaryOperator |
nary(int type,
IMathElement lowerLimit,
IMathElement upperLimit)
Creates a N-ary operator
|
IMathNaryOperator |
nary(int type,
java.lang.String lowerLimit,
java.lang.String upperLimit)
Creates a N-ary operator
|
IMathBar |
overbar()
Sets a bar on the top of this element
|
IMathRadical |
radical(IMathElement degree)
Specifies the mathematical root of the given degree from the specified argument.
|
IMathRadical |
radical(java.lang.String degree)
Specifies the mathematical root of the given degree from the specified argument.
|
IMathLimit |
setLowerLimit(IMathElement limit)
Takes lower limit
|
IMathLimit |
setLowerLimit(java.lang.String limit)
Takes lower limit
|
IMathSubscriptElement |
setSubscript(IMathElement subscript)
Creates subscript
|
IMathSubscriptElement |
setSubscript(java.lang.String subscript)
Creates subscript
|
IMathLeftSubSuperscriptElement |
setSubSuperscriptOnTheLeft(IMathElement subscript,
IMathElement superscript)
Creates subscript and superscript on the left
|
IMathLeftSubSuperscriptElement |
setSubSuperscriptOnTheLeft(java.lang.String subscript,
java.lang.String superscript)
Creates subscript and superscript on the left
|
IMathRightSubSuperscriptElement |
setSubSuperscriptOnTheRight(IMathElement subscript,
IMathElement superscript)
Creates subscript and superscript on the right
|
IMathRightSubSuperscriptElement |
setSubSuperscriptOnTheRight(java.lang.String subscript,
java.lang.String superscript)
Creates subscript and superscript on the right
|
IMathSuperscriptElement |
setSuperscript(IMathElement superscript)
Creates superscript
|
IMathSuperscriptElement |
setSuperscript(java.lang.String superscript)
Creates superscript
|
IMathLimit |
setUpperLimit(IMathElement limit)
Takes upper limit
|
IMathLimit |
setUpperLimit(java.lang.String limit)
Takes upper limit
|
IMathBorderBox |
toBorderBox()
Places this element in a border-box
|
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
|
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.
|
IMathArray |
toMathArray()
Puts in a vertical array
|
IMathBar |
underbar()
Sets a bar on the bottom of this element
|
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);
mathElement
- The element to be joinedIMathBlock 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");
mathText
- Mathematical text to be joinedIMathFraction 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);
denominator
- DenominatorIMathFraction 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");
denominator
- DenominatorIMathFraction 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);
denominator
- DenominatorfractionType
- Fraction type: Bar, NoBar, Skewed, LinearIMathFraction 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);
denominator
- DenominatorfractionType
- Fraction type: Bar, NoBar, Skewed, LinearIMathDelimiter enclose()
Enclose a math element in parenthesis
Example:IMathElement element = new MathematicalText("x"); IMathDelimiter delimiter = element.enclose();
IMathDelimiter
which includes the parenthesisIMathDelimiter 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('[', ']');
beginningCharacter
- Beginning character (usually left bracket)endingCharacter
- Ending character (usually right bracket)IMathDelimiter
which includes specified characters as framingIMathFunction 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);
functionArgument
- An argument of the functionIMathFunction
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");
functionArgument
- An argument of the functionIMathFunction
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);
functionName
- Function nameIMathFunction
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");
functionName
- Function nameIMathFunction
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);
functionType
- One of the common function type of one argumentIMathFunction
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'
functionType
- One of the common function type of two arguments: Log, Lim, Min, MaxadditionalArgument
- Additional argument depending on the type of functionIMathFunction
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'
functionType
- One of the common function type of two arguments: Log, Lim, Min, MaxadditionalArgument
- Additional argument depending on the type of functionIMathFunction
IMathSubscriptElement setSubscript(IMathElement subscript)
Creates subscript
Example:IMathElement element = new MathematicalText("N"); IMathElement index = new MathematicalText("i"); IMathSubscriptElement subscript = element.setSubscript(index);
subscript
- Subscript (lower index on the right)IMathSubscriptElement
IMathSubscriptElement setSubscript(java.lang.String subscript)
Creates subscript
Example:IMathElement element = new MathematicalText("N"); IMathSubscriptElement subscript = element.setSubscript("i");
subscript
- Subscript (lower index on the right)IMathSubscriptElement
IMathSuperscriptElement setSuperscript(IMathElement superscript)
Creates superscript
Example:IMathElement element = new MathematicalText("N"); IMathElement index = new MathematicalText("4"); IMathSuperscriptElement superscript = element.setSuperscript(index);
superscript
- Superscript (upper index on the right)IMathSuperscriptElement
IMathSuperscriptElement setSuperscript(java.lang.String superscript)
Creates superscript
Example:IMathElement element = new MathematicalText("N"); IMathSuperscriptElement superscript = element.setSuperscript("4");
superscript
- Superscript (upper index on the right)IMathSuperscriptElement
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);
subscript
- Subscript (lower index on the right)superscript
- Superscript (upper index on the right)IMathRightSubSuperscriptElement
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");
subscript
- Subscript (lower index on the right)superscript
- Superscript (upper index on the right)IMathRightSubSuperscriptElement
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);
subscript
- Subscript (lower index on the left)superscript
- Superscript (upper index on the left)IMathLeftSubSuperscriptElement
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");
subscript
- Subscript (lower index on the left)superscript
- Superscript (upper index on the left)IMathLeftSubSuperscriptElement
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);
degree
- Argument of RadicalIMathRadical
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");
degree
- Argument of RadicalIMathRadical
IMathLimit setUpperLimit(IMathElement limit)
Takes upper limit
Example:IMathElement baseElement = new MathematicalText("y"); IMathElement limitValue = new MathematicalText("y−>1"); IMathLimit limitElement = baseElement.setUpperLimit(limitValue);
limit
- limitIMathLimit
IMathLimit setUpperLimit(java.lang.String limit)
Takes upper limit
Example:IMathElement baseElement = new MathematicalText("y"); IMathLimit limitElement = baseElement.setUpperLimit("y−>1");
limit
- limitIMathLimit
IMathLimit setLowerLimit(IMathElement limit)
Takes lower limit
Example:IMathElement baseElement = new MathematicalText("lim"); IMathElement limitValue = new MathematicalText("𝑛→∞"); IMathLimit limitElement = baseElement.setLowerLimit(limitValue);
limit
- limitIMathLimit
IMathLimit setLowerLimit(java.lang.String limit)
Takes lower limit
Example:IMathElement baseElement = new MathematicalText("lim"); IMathLimit limitElement = baseElement.setLowerLimit("𝑛→∞");
limit
- limitIMathLimit
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);
type
- The N-ary operator typelowerLimit
- The lower limitupperLimit
- The upper limitIMathNaryOperator
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", "𝑛");
type
- The N-ary operator typelowerLimit
- The lower limitupperLimit
- The upper limitIMathNaryOperator
IMathArray toMathArray()
Puts in a vertical array
Example:IMathArray array = new MathematicalText("x1").join("x2").join("x3").toMathArray();
IMathArray
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);
integralType
- Integral typelowerLimit
- Lower limit of integralupperLimit
- Upper limit of integrallimitLocations
- location of limitsIMathNaryOperator
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);
integralType
- Integral typelowerLimit
- Lower limit of integralupperLimit
- Upper limit of integralIMathNaryOperator
IMathNaryOperator integral(int integralType)
Takes the integral without limits
Example:IMathElement baseElement = new MathematicalText("𝑥"); IMathNaryOperator integral = baseElement.integral(MathIntegralTypes.Contour);
integralType
- Integral typeIMathNaryOperator
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);
integralType
- Integral typelowerLimit
- Lower limit of integralupperLimit
- Upper limit of integrallimitLocations
- location of limitsIMathNaryOperator
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");
integralType
- Integral typelowerLimit
- Lower limit of integralupperLimit
- Upper limit of integralIMathNaryOperator
IMathAccent accent(char accentCharacter)
Sets an accent mark (a character on the top of this element)
Example:IMathAccent accent = new MathematicalText("x").accent('~');
accentCharacter
- Accent character. The value should be within the range of (U+0300–U+036F) or (U+20D0–U+20EF)IMathAccent
IMathBar overbar()
Sets a bar on the top of this element
Example:IMathBar bar = new MathematicalText("x").overbar();
IMathBar
IMathBar underbar()
Sets a bar on the bottom of this element
Example:IMathBar bar = new MathematicalText("x").underbar();
IMathBar
IMathGroupingCharacter group()
Places this element in a group using a bottom curly bracket
Example:IMathGroupingCharacter groupingElement = new MathematicalText("x;y;z").group();
IMathGroupingCharacter
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);
character
- Grouping Character such as BOTTOM CURLY BRACKET (U+23DF) or any otherposition
- Position of grouping characterverticalJustification
- 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 baselineIMathGroupingCharacter
IMathBorderBox toBorderBox()
Places this element in a border-box
Example:IMathBorderBox borderBox = new MathematicalText("x+y+z").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);
hideTop
- Hide Top EdgehideBottom
- Hide Bottom EdgehideLeft
- Hide Left EdgehideRight
- Hide Right EdgestrikethroughHorizontal
- Border Box Strikethrough HorizontalstrikethroughVertical
- Border Box Strikethrough VerticalstrikethroughBottomLeftToTopRight
- Border Box Strikethrough Bottom-Left to Top-RightstrikethroughTopLeftToBottomRight
- Border Box Strikethrough Top-Left to Bottom-RightIMathBox 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();