IMathMatrix class

IMathMatrix class

Specifies the Matrix object, consisting of child elements laid out in one or more rows and columns. It is important to note that matrices do not have built in delimiters. To place the matrix in the brackets you should use the delimiter object (IMathDelimiter). Null arguments can be used to create gaps in matrices.

The IMathMatrix type exposes the following members:

Properties

PropertyDescription
row_countNumber of rows in the matrix
column_countNumber of columns in the matrix
hide_placeholdersHide the placeholders for empty matrix elements
Default: false
base_justificationSpecifies the vertical justification respect to surrounding text.
Possible values are top, bottom, and center.
Default: Center
min_column_widthMinimum column width in twips (1/20th of a point)
The gap spacing (also referred to as “Column Gap” or “Gap Width”) is added to
the MinColumnWidth to determine the total Matrix Column Spacing
(distance between the same edges of different columns).
Default: 0.
column_gap_ruleThe type of horizontal spacing between columns of a matrix;
Horizontal spacing units can be ems or points (stored as twips).
Default: SingleSpacingGap (0)
column_gapThe value of horizontal spacing between columns of a matrix;
If the ColumnGapRule is set to 3 (“Exactly”), then the unit is interpreted as twips (1/20th of a point)
If the ColumnGapRule is set to 4 (“Multiple”), then the unit is interpreted as number of 0.5 em increments.
In other cases ignored.
Default: 0
row_gap_ruleThe type of vertical spacing between rows of a matrix;
Vertical spacing units can be lines or points (stored as twips).
Default: SingleSpacingGap (0)
row_gapThe value of vertical spacing between rows of a matrix;
If the RowGapRule is set to 3 (“Exactly”), then the unit is interpreted as twips (1/20th of a point)
If the RowGapRule is set to 4 (“Multiple”), then the unit is interpreted as half-lines.
Default: 0

Methods

MethodDescription
join
join
divide
divide
divide
divide
enclose
enclose
function
function
as_argument_of_function
as_argument_of_function
as_argument_of_function
as_argument_of_function
as_argument_of_function
set_subscript
set_subscript
set_superscript
set_superscript
set_sub_superscript_on_the_right
set_sub_superscript_on_the_right
set_sub_superscript_on_the_left
set_sub_superscript_on_the_left
radical
radical
set_upper_limit
set_upper_limit
set_lower_limit
set_lower_limit
nary
nary
integral
integral
integral
integral
integral
group
group
to_border_box
to_border_box
get_column_alignmentGet the horizontal alignment of the specified column
set_column_alignmentSet the horizontal alignment of the specified column
set_columns_alignmentSet the horizontal alignment of the specified columns
insert_row_beforeInsert a new row before the specified one
Initially all elements in the new row are None.
insert_row_afterInsert a new row after the specified one
Initially all elements in the new row are None.
delete_rowDeletes the specified row
insert_column_beforeInsert a new column before the specified one
Initially all elements in the new column are None.
insert_column_afterInsert a new column after the specified one
Initially all elements in the new column are None.
delete_columnDeletes the specified column
get_children
to_math_array
accent
overbar
underbar
to_box

See Also