MathDelimiter class

MathDelimiter class

Specifies the delimiter object, consisting of opening and closing characters (such as parentheses, braces, brackets, and vertical bars), and one or more mathematical elements inside, separated by a specified character. Examples: (𝑥2); [𝑥2|𝑦2]

Inheritance:MathDelimiterMathElementBase

The MathDelimiter type exposes the following members:

Constructors

ConstructorDescription
__init__Initializes MathDelimiter with the specified element as single base argument

Properties

PropertyDescription
argumentsOne or more mathematical elements separated by delimiter characters
beginning_characterDelimiter Beginning Character specifies the beginning, or opening, delimiter character.
Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces.
The default: ‘(’.
separator_characterDelimiter Separator Character specifies the character that separates arguments in the delimiter object.
The default: ‘|’.
ending_characterDelimiter Ending Character specifies the ending, or closing, delimiter character.
Mathematical delimiters are enclosing characters such as parentheses, brackets, and braces.
The default: ‘)’.
grow_to_match_operand_heightSpecifies the growth of BeginningCharacter, SeparatorCharacter, EndingCharacter
When true, the delimiters grows vertically to match its operand height.
The default value is true
delimiter_shapeSpecifies the shape of delimiters in the delimiter object.
When is MathDelimiterShape.Centered, delimiters are centered around the math axis of the mathematical text
and still be made to fit the entire height of their contents.
When is MathDelimiterShape.Match, their height and shape are altered to exactly match their contents.

Methods

MethodDescription
joinJoins a mathematical element and forms a mathematical block
joinJoins a mathematical text and forms a mathematical block
divideCreates a fraction with this numerator and specified denominator
divideCreates a fraction with this numerator and specified denominator
divideCreates a fraction of the specified type with this numerator and specified denominator
divideCreates a fraction of the specified type with this numerator and specified denominator
encloseEncloses a math element in specified characters such as parenthesis or another characters as framing
encloseEncloses a math element in parenthesis
functionTakes a function of an argument using this instance as the function name
functionTakes a function of an argument using this instance as the function name
as_argument_of_functionTakes specified function using this instance as the argument
as_argument_of_functionTakes specified function using this instance as the argument
as_argument_of_functionTakes specified function using this instance as the argument
as_argument_of_functionTakes specified function using this instance as the argument and specified additional argument
as_argument_of_functionTakes specified function using this instance as the argument and specified additional argument
set_subscriptCreates subscript
set_subscriptCreates subscript
set_superscriptCreates superscript
set_superscriptCreates superscript
set_sub_superscript_on_the_rightCreates subscript and superscript on the right
set_sub_superscript_on_the_rightCreates subscript and superscript on the right
set_sub_superscript_on_the_leftCreates subscript and superscript on the left
set_sub_superscript_on_the_leftCreates subscript and superscript on the left
radicalSpecifies the mathematical root of the given degree from the specified argument.
radicalSpecifies the mathematical root of the given degree from the specified argument.
set_upper_limitTakes upper limit
set_upper_limitTakes upper limit
set_lower_limitTakes lower limit
set_lower_limitTakes lower limit
naryCreates a N-ary operator
naryCreates a N-ary operator
integralTakes the integral
integralTakes the integral
integralTakes the integral without limits
integralTakes the integral
integralTakes the integral
groupPlaces this element in a group using a bottom curly bracket
groupPlaces this element in a group using a grouping character such as bottom curly bracket or another
to_border_boxPlaces this element in a border-box
to_border_boxPlaces this element in a border-box
to_math_arrayPuts in a vertical array
accentSets an accent mark (a character on the top of this element)
overbarSets a bar on the top of this element
underbarSets a bar on the bottom of this element
to_boxPlaces 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.
delimitDelimits arguments using the specified delimiter character
get_childrenGet children elements

See Also