ITable
pentaho.data. ITable
The ITable
interface exposes the data and metadata of a tabular dataset.
Source: doc-js/pentaho/data/ITable.jsdoc, line 17
Methods
Name | Description |
---|---|
filter(filter) : pentaho.data.TableView | Returns a view for the subset of rows of a data table that are selected by this filter. |
filterMatchesRow(filter, rowIndex) : boolean | Gets a value that indicates if a given filter includes a given row. |
getCell(rowIndex, colIndex) : pentaho.data.ICell | Gets a cell, given its row and column indexes. |
getColumnId(colIndex) : string | Gets the id of a column, given its index. |
getColumnIndexByAttribute(attr) : number Deprecated | Gets the index of the first column having a given attribute. |
getColumnIndexById(id) : number | Gets the index of the first column having a given identifier. |
getColumnLabel(colIndex) : string | Gets the label of a column, given its index. |
getColumnProperty(colIndex, propName) : any | Gets a metadata property of a column, given the column index and property name. |
getColumnType(colIndex) : string | Gets the type name of the values of a column's attribute, given its index. |
getFormattedValue(rowIndex, colIndex) : string | Gets a best-effort formatted value of a cell, given its row and column indexes. |
getLabel(rowIndex, colIndex) : string | undefined | Gets the formatted value property of a cell, given its row and column indexes. |
getNumberOfColumns() : number | Gets the number of columns. |
getNumberOfRows() : number | Gets the number of rows. |
getValue(rowIndex, colIndex) : any | null | Gets the value of a cell, given its row and column indexes. |
getValueKey(rowIndex, colIndex) : string | Gets the key of the value of a cell, given its row and column indexes. |
isColumnKey(colIndex) : boolean | Gets a value that indicates if a column's values identify each row, together with other key columns, given its index. |
Methods Details
filter(filter) : pentaho.data.TableView | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Returns a view for the subset of rows of a data table that are selected by this filter. Source: doc-js/pentaho/data/ITable.jsdoc, line 177
|
filterMatchesRow(filter, rowIndex) : boolean | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given filter includes a given row. Source: doc-js/pentaho/data/ITable.jsdoc, line 162
|
getCell(rowIndex, colIndex) : pentaho.data.ICell | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a cell, given its row and column indexes. Depending on the underlying implementation, this method may allocate memory. Source: doc-js/pentaho/data/ITable.jsdoc, line 86
|
getColumnId(colIndex) : string | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the id of a column, given its index. Source: doc-js/pentaho/data/ITable.jsdoc, line 40
|
getColumnIndexByAttribute(attr) : number Deprecated | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the index of the first column having a given attribute. Source: doc-js/pentaho/data/ITable.jsdoc, line 191
See also: pentaho.data.ITable#getColumnIndexById |
getColumnIndexById(id) : number | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the index of the first column having a given identifier. Source: doc-js/pentaho/data/ITable.jsdoc, line 205
|
getColumnLabel(colIndex) : string | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the label of a column, given its index. Source: doc-js/pentaho/data/ITable.jsdoc, line 49
|
getColumnProperty(colIndex, propName) : any | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a metadata property of a column, given the column index and property name. Source: doc-js/pentaho/data/ITable.jsdoc, line 76
|
getColumnType(colIndex) : string | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets the type name of the values of a column's attribute, given its index. Source: doc-js/pentaho/data/ITable.jsdoc, line 58
|
getFormattedValue(rowIndex, colIndex) : string | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a best-effort formatted value of a cell, given its row and column indexes. If the cell has a specified label, then the string representation of that value is returned. Otherwise, if the cell has a specified value, then the string representation of that value is returned. When both the cell's formatted value and value are Contrast this method with Source: doc-js/pentaho/data/ITable.jsdoc, line 139
|
getLabel(rowIndex, colIndex) : string | undefined | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the formatted value property of a cell, given its row and column indexes. This method returns the string representation of the cell's Contrast this method with Source: doc-js/pentaho/data/ITable.jsdoc, line 123
|
getNumberOfColumns() : number | ||||
---|---|---|---|---|
Gets the number of columns. Source: doc-js/pentaho/data/ITable.jsdoc, line 24
|
getNumberOfRows() : number | ||||
---|---|---|---|---|
Gets the number of rows. Source: doc-js/pentaho/data/ITable.jsdoc, line 32
|
getValue(rowIndex, colIndex) : any | null | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the value of a cell, given its row and column indexes. When a cell is missing or has a Source: doc-js/pentaho/data/ITable.jsdoc, line 98
|
getValueKey(rowIndex, colIndex) : string | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the key of the value of a cell, given its row and column indexes. When a cell contains the Source: doc-js/pentaho/data/ITable.jsdoc, line 111
|
isColumnKey(colIndex) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a column's values identify each row, together with other key columns, given its index. Source: doc-js/pentaho/data/ITable.jsdoc, line 67
|