BiOlapGridSelectionModel
Selection model for BiOlapGrid. This selection model contains of selected areas (BiArea). An area consists of a left, top, width and height propertty. Two selected areas may overlap so be careful when trying to get all selected cells. The selectedItems collection is a BiAreaCollection
This class extends BiSelectionModel and therefore all methods and fields available for BiSelectionModel are also available for BiOlapGridSelectionModel .
Constructor
new BiOlapGridSelectionModel ( oOwner )
Parameters
| Name | Type | Optional | Default | Descripton |
oOwner | | The OLAP grid that the selection is working with |
Properties
| Name | Type | get | set | Descripton |
dataModel | |  | The data model used with the OLAP grid | |
items | | | Returns an area collection. This overrides the default implementation which returns an array of items. | |
viewManager | | | The view manager used with the OLAP grid |
Methods
| Name | Description |
getCellIsAnchor | Returns whether the cell at (x, y) is the anchor item |
getCellIsLead | Returns whether the cell at (x, y) is the lead item |
getCellSelected | Returns whether the cell at (x, y) is selected |
getColumnSelected | Returns whether the column at x is selected |
getRowSelected | Returns whether the row at y is selected |
setCellSelected | Sets the selected state for the cell at x, y |
setColumnSelected | Sets the selected state for the column at x |
setRowSelected | Sets the selected state for the row at y |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
None.
Method Details
getCellIsAnchor
Returns whether the cell at (x, y) is the anchor item
Syntax
object.getCellIsAnchor ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to check | ||
y | Number | The row index of the cell to check |
Return Type
Boolean
getCellIsLead
Returns whether the cell at (x, y) is the lead item
Syntax
object.getCellIsLead ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to check | ||
y | Number | The row index of the cell to check |
Return Type
Boolean
getCellSelected
Returns whether the cell at (x, y) is selected
Syntax
object.getCellSelected ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to check | ||
y | Number | The row index of the cell to check |
Return Type
Boolean
getColumnSelected
Returns whether the column at x is selected
Syntax
object.getColumnSelected ( x ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The index of the column to check |
Return Type
Boolean
getRowSelected
Returns whether the row at y is selected
Syntax
object.getRowSelected ( y ) Parameters
| Name | Type | Optional | Default | Descripton |
y | Number | The index of the row to check |
Return Type
Boolean
setCellSelected
Sets the selected state for the cell at x, y
Syntax
object.setCellSelected ( x,y,b ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index of the cell to select or deselect | ||
y | Number | The row index of the cell to select or deselect | ||
b | Boolean | Whether to select or deselect the cell |
Return Type
void
setColumnSelected
Sets the selected state for the column at x
Syntax
object.setColumnSelected ( x,b ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The index of the column to select or deselect | ||
b | Boolean | Whether to select or deselect the column |
Return Type
void
setRowSelected
Sets the selected state for the row at y
Syntax
object.setRowSelected ( y,b ) Parameters
| Name | Type | Optional | Default | Descripton |
y | Number | The index of the row to select or deselect | ||
b | Boolean | Whether to select or deselect the row |
Return Type
void