BiOlapGridDataModel
This defines the interface that is needed for a data model for a BiOlapGrid. This actually implements a dummy data model. Extend this class to create more useful data models.
* All methods in this data model can be safely overriden without calling the super class since there are no side effects in any of the methods.
This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiOlapGridDataModel .
Constructor
new BiOlapGridDataModel ( )
Parameters
No parameters.
Properties
None.
Methods
| Name | Description |
getAxisCellStartPosition | Given a position, at what postion does the axis cell start at? You may return null here and in that case the view manager handles this case. If you know this you should implement it because the implementation provided by the view manager is very general and therefore not too efficient. |
getAxisCellStyle | This allows a custom CSS text to be applied to a axis header cell. This allows more detailed control over the rendering of the header cell. |
getAxisCellText | This should return the text (HTML string) to show for the axis header cell |
getAxisCellWidth | This is the number of positions the axis cell takes up. |
getAxisContextMenu | This allows a context menu to be shown when the user invokes the context menu on one of the axis header cells |
getAxisDimensionCount | This returns the number of dimensions on the given axis |
getAxisDimensionName | Returns the name of a dimension |
getAxisDropDataTypes | Returns the supported data types for the axis header cell. Return [] or null if no drop is desired on the cell |
getAxisPositionWidth | This returns the number of positions the axis takes up |
getAxisToolTip | This should return the tool tip to use for an axis header cell |
getCellStyle | This allows a custom CSS text to be applied to a cell. This allows more detailed control over the rendering of the cell. |
getCellText | This should return the text (HTML string) to show for the cell at (x,y) |
getContextMenu | This allows a context menu to be shown when the user invokes the context menu on the cell |
getDropDataTypes | Returns the supported data types for the cell. Return [] or null if no drop is desired on the cell |
getFillerCellStyle | This allows a custom CSS text to be applied to a filler cell. A filler cell is shown when the real cells do not fill the entire viewport. |
getHasIcon | Returns whether the cell should display an icon. If this is the case the actual image URI is returned using getIcon |
getIcon | Returns the path to the image to show on the cell. This is only called for cells that should have an icon accordingly to getHasIcon You should use an absolute URI here to make the application more flexible. |
getIconStyle | Use this to specify some custom CSS to use for the icon image. |
getToolTip | This should return the tool tip to use for the cell |
Events
None.
Static Methods
None.
Static Fields
None.
Remarks
None.
Method Details
getAxisCellStartPosition
Given a position, at what postion does the axis cell start at? You may return null here and in that case the view manager handles this case. If you know this you should implement it because the implementation provided by the view manager is very general and therefore not too efficient.
Syntax
object.getAxisCellStartPosition ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis the cell is part of | ||
nDim | Number | The dimension index | ||
nPos | Number | A position that the the axis cell covers |
Return Type
Number
getAxisCellStyle
This allows a custom CSS text to be applied to a axis header cell. This allows more detailed control over the rendering of the header cell.
Syntax
object.getAxisCellStyle ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis of the header cell | ||
nDim | Number | The dimension index | ||
nPos | Number | The start position for the header cell |
Return Type
String
getAxisCellText
This should return the text (HTML string) to show for the axis header cell
Syntax
object.getAxisCellText ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis of the cell | ||
nDim | Number | The dimension for the cell | ||
nPos | Number | The start position for the axis cell |
Return Type
String
getAxisCellWidth
This is the number of positions the axis cell takes up.
Syntax
object.getAxisCellWidth ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis of the cell | ||
nDim | Number | The dimension for the cell | ||
nPos | Number | The start position for the axis cell |
Return Type
Number
getAxisContextMenu
This allows a context menu to be shown when the user invokes the context menu on one of the axis header cells
Syntax
object.getAxisContextMenu ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis that we want the context menu for | ||
nDim | Number | The dimension index | ||
nPos | Number | The start position of the axis header cell |
Return Type
getAxisDimensionCount
This returns the number of dimensions on the given axis
Syntax
object.getAxisDimensionCount ( nAxis ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis to get the dimension count for |
Return Type
Number
getAxisDimensionName
Returns the name of a dimension
Syntax
object.getAxisDimensionName ( nAxis,nDim ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis the dimension is part of | ||
nDim | Number | The index of the dimension |
Return Type
String
getAxisDropDataTypes
Returns the supported data types for the axis header cell. Return [] or null if no drop is desired on the cell
Syntax
object.getAxisDropDataTypes ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis that we want the drop data types for | ||
nDim | Number | The dimension the header cell is part of | ||
nPos | Number | The start position of the header cell |
Return Type
String[]
getAxisPositionWidth
This returns the number of positions the axis takes up
Syntax
object.getAxisPositionWidth ( nAxis ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis to get the position width |
Return Type
Number
getAxisToolTip
This should return the tool tip to use for an axis header cell
Syntax
object.getAxisToolTip ( nAxis,nDim,nPos ) Parameters
| Name | Type | Optional | Default | Descripton |
nAxis | Number | The axis that we want the tool tip for | ||
nDim | Number | The dimension the header cell is part of | ||
nPos | Number | The start position of the header cell |
Return Type
getCellStyle
This allows a custom CSS text to be applied to a cell. This allows more detailed control over the rendering of the cell.
Syntax
object.getCellStyle ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
String
getCellText
This should return the text (HTML string) to show for the cell at (x,y)
Syntax
object.getCellText ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
String
getContextMenu
This allows a context menu to be shown when the user invokes the context menu on the cell
Syntax
object.getContextMenu ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
getDropDataTypes
Returns the supported data types for the cell. Return [] or null if no drop is desired on the cell
Syntax
object.getDropDataTypes ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
String[]
getFillerCellStyle
This allows a custom CSS text to be applied to a filler cell. A filler cell is shown when the real cells do not fill the entire viewport.
Syntax
object.getFillerCellStyle ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
String
getHasIcon
Returns whether the cell should display an icon. If this is the case the actual image URI is returned using getIcon
Syntax
object.getHasIcon ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
Boolean
getIcon
Returns the path to the image to show on the cell. This is only called for cells that should have an icon accordingly to getHasIcon
You should use an absolute URI here to make the application more flexible.
Syntax
object.getIcon ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |
Return Type
String
getIconStyle
Use this to specify some custom CSS to use for the icon image.
Syntax
object.getIconStyle ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell containing the icon | ||
y | Number | The row index for the cell row containing the icon |
Return Type
String
getToolTip
This should return the tool tip to use for the cell
Syntax
object.getToolTip ( x,y ) Parameters
| Name | Type | Optional | Default | Descripton |
x | Number | The column index for the cell | ||
y | Number | The row index for the cell |