Interface ITable
Represents an Index Table of an object (INode) in a Batch.
Note: Write-access to properties depends on the context in which the model is used. When in a read-only context, set* methods will throw an Error.
Properties
list
Methods
list
Properties
columnCount
Declaration
readonly columnCount: number;
Property Value
columns
Declaration
readonly columns: Array<IField>;
Property Value
| Type |
Description |
| Array<IField> |
|
name
Declaration
Property Value
rowCount
Declaration
readonly rowCount: number;
Property Value
Methods
addRow()
Add a new (empty) row to the table.
Note: this method will throw an Error if invoked in read-only context.
Declaration
Returns
deleteRow(index)
Removes the row at the supplied index.
Note: this method will throw an Error if invoked in read-only context.
Declaration
deleteRow(index: number): any;
Parameters
| Type |
Name |
Description |
| number |
index |
|
Returns
getColumnCount()
Returns the number of columns in this table.
Declaration
getColumnCount(): number;
Returns
getColumns()
Get the columns of this table. Each column is represented by an IField object which serves as the column's definition (specifying its type, validations, format etc)
Declaration
getColumns(): Array<IField>;
Returns
| Type |
Description |
| Array<IField> |
|
getName()
Returns the name of this table
Declaration
Returns
getRowCount()
Returns the number of rows in this table.
Declaration
Returns
getValueAt(row, column)
Get the value at the given row and column in the table
Declaration
getValueAt(row: number, column: number): string;
Parameters
| Type |
Name |
Description |
| number |
row |
|
| number |
column |
|
Returns
insertRow(index)
Insert a new, empty row in the table at the specified index
Note: this method will throw an Error if invoked in read-only context.
Declaration
insertRow(index: number): any;
Parameters
| Type |
Name |
Description |
| number |
index |
|
Returns
setValueAt(row, column, value)
Sets the value at the specified row and column for this table in a read-write context. You should make sure that the value you write is in the standard internal format. For example, if you are setting a date like Feb 3, 2015, the value should be '2015-02-03'. Do not call this method with a user-formatted value (e.g. 3/2/2015) because it will create incosistencies that are hard to identify later.
Note: this method will throw an Error if invoked in read-only context.
Declaration
setValueAt(row: number, column: number, value: string): any;
Parameters
| Type |
Name |
Description |
| number |
row |
|
| number |
column |
|
| string |
value |
|
Returns