BiGrid2Row
This class is used as the data for rows in the BiGrid2 component
This class extends BiObject and therefore all methods and fields available for BiObject are also available for BiGrid2Row .
Constructor
new BiGrid2Row ( oData )
Parameters
| Name | Type | Optional | Default | Descripton |
oData | Object[] | Optional array of objects describing the data for the cells |
Properties
| Name | Type | get | set | Descripton |
cells | | ![]() | The cells in the row | |
grid | | ![]() | The grid that the row is part of | |
isAnchor | Boolean | ![]() | Whether the row is the selection anchor for the current selection | |
isLead | Boolean | ![]() | Whether the row is the lead item of the selection | |
selected | Boolean | ![]() | Whether the row is selected |
Methods
| Name | Description |
addCell | Adds a cell to the row |
getCell | Returns the cell for the given column |
getData | Returns the data at the given column |
removeCell | Removes a cell from the row |
setData | Sets the data for the cell at the given column |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
None.
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 | | Optional cell to insert the new cell before |
Return Type
void
getCell
Returns the cell for the given column
Syntax
object.getCell ( nCol ) Parameters
| Name | Type | Optional | Default | Descripton |
nCol | Number | The column index for the cell to get |
Return Type
getData
Returns the data at the given column
Syntax
object.getData ( nCol ) Parameters
| Name | Type | Optional | Default | Descripton |
nCol | Number | The column index for the data |
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 the cell at the given column
Syntax
object.setData ( nCol,oData ) Parameters
| Name | Type | Optional | Default | Descripton |
nCol | Number | The column index for the data | ||
oData | Object | The data associated with the cell at the given column |
Return Type
Object
