MathBox class

Specifies the logical boxing (packaging) of mathematical element. For example, a boxed object can 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. For example, the “==” operator should be boxed to prevent line breaks.

Inheritance:MathBox → MathElementBase

The MathBox type exposes the following members:

Constructors

Constructor	Description
`__init__`	Initializes MathBox with the specified element as an argument

Properties

Property	Description
`base`	Base argument
`operator_emulator`	Operator Emulator. When true, the box and its contents behave as a single operator and inherit the properties of an operator. This means, for example, that the character can serve as a point for a line break and can be aligned to other operators. Operator Emulators are often used when one or more glyphs combine to form an operator, such as ‘==’. Default value: false
`no_break`	No break This property specifies the “unbreakable” property on the object box. When true, no line breaks can occur within the box. This can be important for operator emulators that consist of more than one binary operator. When this element is not specified, breaks can occur inside box. Default: true
`differential`	Differential When true, the box acts as a differential (e.g., 𝑑𝑥 in an integrand), and receives the appropriate horizontal spacing for the mathematical differential. Default: false
`alignment_point`	When true, this operator emulator serves as an alignment point; that is, designated alignment points in other equations can be aligned with it. Default: false
`explicit_break`	Explicit break specifies whether there is a line break at the start of the Box object, such that the line wraps at the start of the box object. Specifies the number of the operator on the previous line of mathematical text which shall be used as the alignment point for the current line of mathematical text possible values: 1..255 Default: 0 (no explicit break)

Methods

Method	Description
`join`	Joins a mathematical element and forms a mathematical block
`join`	Joins a mathematical text and forms a mathematical block
`divide`	Creates a fraction with this numerator and specified denominator
`divide`	Creates a fraction with this numerator and specified denominator
`divide`	Creates a fraction of the specified type with this numerator and specified denominator
`divide`	Creates a fraction of the specified type with this numerator and specified denominator
`enclose`	Encloses a math element in parenthesis
`enclose`	Encloses a math element in specified characters such as parenthesis or another characters as framing
`function`	Takes a function of an argument using this instance as the function name
`function`	Takes a function of an argument using this instance as the function name
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument
`as_argument_of_function`	Takes specified function using this instance as the argument and specified additional argument
`as_argument_of_function`	Takes specified function using this instance as the argument and specified additional argument
`set_subscript`	Creates subscript
`set_subscript`	Creates subscript
`set_superscript`	Creates superscript
`set_superscript`	Creates superscript
`set_sub_superscript_on_the_right`	Creates subscript and superscript on the right
`set_sub_superscript_on_the_right`	Creates subscript and superscript on the right
`set_sub_superscript_on_the_left`	Creates subscript and superscript on the left
`set_sub_superscript_on_the_left`	Creates subscript and superscript on the left
`radical`	Specifies the mathematical root of the given degree from the specified argument.
`radical`	Specifies the mathematical root of the given degree from the specified argument.
`set_upper_limit`	Takes upper limit
`set_upper_limit`	Takes upper limit
`set_lower_limit`	Takes lower limit
`set_lower_limit`	Takes lower limit
`nary`	Creates a N-ary operator
`nary`	Creates a N-ary operator
`integral`	Takes the integral
`integral`	Takes the integral
`integral`	Takes the integral without limits
`integral`	Takes the integral
`integral`	Takes the integral
`group`	Places this element in a group using a bottom curly bracket
`group`	Places this element in a group using a grouping character such as bottom curly bracket or another
`to_border_box`	Places this element in a border-box
`to_border_box`	Places this element in a border-box
`to_math_array`	Puts in a vertical array
`accent`	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
`to_box`	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.
`get_children`	Get children elements

MathBox class

MathBox class

Constructors

Properties

Methods

See Also