public interface IMathMatrix extends IMathElement
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.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.set_Item(0, 0, new MathematicalText("item.1.1"));
Modifier and Type | Method and Description |
---|---|
void |
deleteColumn(int columnIndex)
Deletes the specified column
|
void |
deleteRow(int rowIndex)
Deletes the specified row
|
IMathElement |
get_Item(int row,
int column)
Elements of matrix
|
int |
getBaseJustification()
Specifies the vertical justification respect to surrounding text.
|
int |
getColumnAlignment(int columnIndex)
Get the horizontal alignment of the specified column
|
int |
getColumnCount()
Number of columns in the matrix
|
long |
getColumnGap()
The 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.
|
int |
getColumnGapRule()
The type of horizontal spacing between columns of a matrix;
Horizontal spacing units can be ems or points (stored as twips).
|
boolean |
getHidePlaceholders()
Hide the placeholders for empty matrix elements
Default: false
|
long |
getMinColumnWidth()
Minimum 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).
|
int |
getRowCount()
Number of rows in the matrix
|
long |
getRowGap()
The 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.
|
int |
getRowGapRule()
The type of vertical spacing between rows of a matrix;
Vertical spacing units can be lines or points (stored as twips).
|
void |
insertColumnAfter(int columnIndex)
Insert a new column after the specified one
Initially all elements in the new column are null.
|
void |
insertColumnBefore(int columnIndex)
Insert a new column before the specified one
Initially all elements in the new column are null.
|
void |
insertRowAfter(int rowIndex)
Insert a new row after the specified one
Initially all elements in the new row are null.
|
void |
insertRowBefore(int rowIndex)
Insert a new row before the specified one
Initially all elements in the new row are null.
|
void |
set_Item(int row,
int column,
IMathElement value)
Elements of matrix
|
void |
setBaseJustification(int value)
Specifies the vertical justification respect to surrounding text.
|
void |
setColumnAlignment(int columnIndex,
int val)
Set the horizontal alignment of the specified column
|
void |
setColumnGap(long value)
The 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.
|
void |
setColumnGapRule(int value)
The type of horizontal spacing between columns of a matrix;
Horizontal spacing units can be ems or points (stored as twips).
|
void |
setColumnsAlignment(int columnIndex,
long columnsCount,
int val)
Set the horizontal alignment of the specified columns
|
void |
setHidePlaceholders(boolean value)
Hide the placeholders for empty matrix elements
Default: false
|
void |
setMinColumnWidth(long value)
Minimum 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).
|
void |
setRowGap(long value)
The 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.
|
void |
setRowGapRule(int value)
The type of vertical spacing between rows of a matrix;
Vertical spacing units can be lines or points (stored as twips).
|
accent, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, asArgumentOfFunction, divide, divide, divide, divide, enclose, enclose, function, function, group, group, integral, integral, integral, integral, integral, join, join, nary, nary, overbar, radical, radical, setLowerLimit, setLowerLimit, setSubscript, setSubscript, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheLeft, setSubSuperscriptOnTheRight, setSubSuperscriptOnTheRight, setSuperscript, setSuperscript, setUpperLimit, setUpperLimit, toBorderBox, toBorderBox, toBox, toMathArray, underbar
IMathElement get_Item(int row, int column)
Elements of matrix
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.set_Item(0, 0, new MathematicalText("item.1.1"));
row
- The zero-based index of the row to get itemcolumn
- The zero-based index of the column to get itemvoid set_Item(int row, int column, IMathElement value)
Elements of matrix
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.set_Item(0, 0, new MathematicalText("item.1.1"));
row
- The zero-based index of the row to get itemcolumn
- The zero-based index of the column to get itemint getRowCount()
Number of rows in the matrix
Example:IMathMatrix matrix = new MathMatrix(2, 3); int rowCount = matrix.getRowCount();
int getColumnCount()
Number of columns in the matrix
Example:IMathMatrix matrix = new MathMatrix(2, 3); int columnCount = matrix.getColumnCount();
boolean getHidePlaceholders()
Hide the placeholders for empty matrix elements Default: false
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setHidePlaceholders(true);
void setHidePlaceholders(boolean value)
Hide the placeholders for empty matrix elements Default: false
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setHidePlaceholders(true);
int getBaseJustification()
Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setBaseJustification(MathVerticalAlignment.Center);
void setBaseJustification(int value)
Specifies the vertical justification respect to surrounding text. Possible values are top, bottom, and center. Default: Center
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setBaseJustification(MathVerticalAlignment.Center);
long getMinColumnWidth()
Minimum 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.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setMinColumnWidth(20);
void setMinColumnWidth(long value)
Minimum 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.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setMinColumnWidth(20);
int getColumnGapRule()
The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0)
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnGapRule(MathSpacingRules.OneAndHalfSpacingGap);
void setColumnGapRule(int value)
The type of horizontal spacing between columns of a matrix; Horizontal spacing units can be ems or points (stored as twips). Default: SingleSpacingGap (0)
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnGapRule(MathSpacingRules.OneAndHalfSpacingGap);
long getColumnGap()
The 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
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnGapRule(MathSpacingRules.Exactly); matrix.setColumnGap(20);
void setColumnGap(long value)
The 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
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnGapRule(MathSpacingRules.Exactly); matrix.setColumnGap(20);
int getRowGapRule()
The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0)
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setRowGapRule(MathSpacingRules.OneAndHalfSpacingGap);
void setRowGapRule(int value)
The type of vertical spacing between rows of a matrix; Vertical spacing units can be lines or points (stored as twips). Default: SingleSpacingGap (0)
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setRowGapRule(MathSpacingRules.OneAndHalfSpacingGap);
long getRowGap()
The 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
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setRowGapRule(MathSpacingRules.Exactly); matrix.setRowGap(20);
void setRowGap(long value)
The 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
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setRowGapRule(MathSpacingRules.Exactly); matrix.setRowGap(20);
int getColumnAlignment(int columnIndex)
Get the horizontal alignment of the specified column
Example:IMathMatrix matrix = new MathMatrix(2, 3); MathHorizontalAlignment alignment = matrix.getColumnAlignment(0);
columnIndex
- Zero-based column indexvoid setColumnAlignment(int columnIndex, int val)
Set the horizontal alignment of the specified column
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnAlignment(0, MathHorizontalAlignment.Left);
columnIndex
- Zero-based column indexval
- New value of horizontal alignment of specified columnvoid setColumnsAlignment(int columnIndex, long columnsCount, int val)
Set the horizontal alignment of the specified columns
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.setColumnAlignment(0, 3, MathHorizontalAlignment.Left);
columnIndex
- Zero-based index of the first column to set alignmentcolumnsCount
- The number of columns to specify the alignmentval
- New value of horizontal alignment of specified columnvoid insertRowBefore(int rowIndex)
Insert a new row before the specified one Initially all elements in the new row are null.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.insertRowBefore(1);
rowIndex
- Index of the row before which to insert a new onevoid insertRowAfter(int rowIndex)
Insert a new row after the specified one Initially all elements in the new row are null.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.insertRowAfter(1);
rowIndex
- Index of the row after which to insert a new onevoid deleteRow(int rowIndex)
Deletes the specified row
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.deleteRow(0);
rowIndex
- The zero-based index of the row to delete.void insertColumnBefore(int columnIndex)
Insert a new column before the specified one Initially all elements in the new column are null.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.insertColumnBefore(0);
columnIndex
- Index of the column before which to insert a new onevoid insertColumnAfter(int columnIndex)
Insert a new column after the specified one Initially all elements in the new column are null.
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.insertColumnAfter(0);
columnIndex
- Index of the column after which to insert a new onevoid deleteColumn(int columnIndex)
Deletes the specified column
Example:IMathMatrix matrix = new MathMatrix(2, 3); matrix.deleteColumn(0);
columnIndex
- The zero-based index of the column to delete.