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

NameDescription
getAxisCellStartPositionGiven 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.
getAxisCellStyleThis 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.
getAxisCellTextThis should return the text (HTML string) to show for the axis header cell
getAxisCellWidthThis is the number of positions the axis cell takes up.
getAxisContextMenuThis allows a context menu to be shown when the user invokes the context menu on one of the axis header cells
getAxisDimensionCountThis returns the number of dimensions on the given axis
getAxisDimensionNameReturns the name of a dimension
getAxisDropDataTypesReturns the supported data types for the axis header cell. Return [] or null if no drop is desired on the cell
getAxisPositionWidthThis returns the number of positions the axis takes up
getAxisToolTipThis should return the tool tip to use for an axis header cell
getCellStyleThis allows a custom CSS text to be applied to a cell. This allows more detailed control over the rendering of the cell.
getCellTextThis should return the text (HTML string) to show for the cell at (x,y)
getContextMenuThis allows a context menu to be shown when the user invokes the context menu on the cell
getDropDataTypesReturns the supported data types for the cell. Return [] or null if no drop is desired on the cell
getFillerCellStyleThis 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.
getHasIconReturns whether the cell should display an icon. If this is the case the actual image URI is returned using getIcon
getIconReturns 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.
getIconStyleUse this to specify some custom CSS to use for the icon image.
getToolTipThis 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis the cell is part of
nDimNumberThe dimension index
nPosNumberA 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis of the header cell
nDimNumberThe dimension index
nPosNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis of the cell
nDimNumberThe dimension for the cell
nPosNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis of the cell
nDimNumberThe dimension for the cell
nPosNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis that we want the context menu for
nDimNumberThe dimension index
nPosNumberThe start position of the axis header cell

Return Type

BiMenu

getAxisDimensionCount

This returns the number of dimensions on the given axis

Syntax

object.getAxisDimensionCount ( nAxis )

Parameters

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis to get the dimension count for

Return Type

Number

getAxisDimensionName

Returns the name of a dimension

Syntax

object.getAxisDimensionName ( nAxis,nDim )

Parameters

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis the dimension is part of
nDimNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis that we want the drop data types for
nDimNumberThe dimension the header cell is part of
nPosNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe 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

NameTypeOptionalDefaultDescripton
nAxisNumberThe axis that we want the tool tip for
nDimNumberThe dimension the header cell is part of
nPosNumberThe start position of the header cell

Return Type

BiToolTip

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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe row index for the cell

Return Type

BiMenu

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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell containing the icon
yNumberThe 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

NameTypeOptionalDefaultDescripton
xNumberThe column index for the cell
yNumberThe row index for the cell

Return Type

BiToolTip