BiGridRow
This class represents the rows in BiGrid. Each row contains cells that contains the text to show for the column.
This class extends BiAbstractGridRow and therefore all methods and fields available for BiAbstractGridRow are also available for BiGridRow .
Constructor
new BiGridRow ( [ oData ] )
Parameters
| Name | Type | Optional | Default | Descripton |
oData | Object[] | ![]() | This is an array containing the data to be used for each cell. If this argument is left out the cells will be have to be added using addCell. |
Properties
| Name | Type | get | set | Descripton |
cells | | ![]() | Returns the cells for the row. | |
cssClassName | String | ![]() | Returns the CSS class name used for the row. | |
grid | | ![]() | Returns the grid component that the row is part of | |
html | String | ![]() | Returns the HTML for the row and all its cells. This is used by the BiAbstractGrid gridBodyHtml property when drawing the grid. | |
nextSiblingRow | | ![]() | Returns the next grid row sibling. | |
previousSiblingRow | | ![]() | Returns the previous grid row sibling. | |
rowHeaderHtml | String | ![]() | Returns the HTML used for the row header for the row. | |
rowHeaderLabelHtml | String | ![]() | Returns the HTML for the text on the row header used for the row. Override this method to define what to show on the row header. | |
rowIndex | Number | ![]() | The index of the row |
Methods
| Name | Description |
addCell | Adds a cell to the row |
getCell | Returns the cell for the given column index. |
getData | Returns the data for the given column index |
removeCell | Removes a cell from the row |
setData | Sets the data for a given column index |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
Changing the grid row does not automatically update the grid. The grid will have to be updated manually.
Method Details
addCell
Adds a cell to the row
Syntax
object.addCell ( oChild [ ,oBefore ] ) Parameters
| Name | Type | Optional | Default | Descripton |
oChild | | The cell to add | ||
oBefore | | ![]() | If provided, oChild is added before this cell |
Return Type
void
getCell
Returns the cell for the given column index.
Syntax
object.getCell ( nCol ) Parameters
| Name | Type | Optional | Default | Descripton |
nCol | Number | The column to get the cell for |
Return Type
getData
Returns the data for the given column index
Syntax
object.getData ( x ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to get the data for |
Return Type
Object
removeCell
Removes a cell from the row
Syntax
object.removeCell ( oChild ) Parameters
| Name | Type | Optional | Default | Descripton |
oChild | | The cell to remove |
Return Type
setData
Sets the data for a given column index
Syntax
object.setData ( x,oData ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to set the data for | ||
oData | Object | The data to set on the cell |
Return Type
void
