BiOlapGrid

This class is used to display an OLAP Grid

This class extends BiTreeViewBase and therefore all methods and fields available for BiTreeViewBase are also available for BiOlapGrid .

Constructor

new BiOlapGrid ( )

Parameters

No parameters.

Properties

Name	Type	get	set	Descripton
allowHeaderSelection	BiOlapGridSelectionModel			Whether clicking on a dimension header also selects the rows/column of the header.
allowTab	Boolean			Whether pressing the tab key should change the selected cell or navigate to the next component in the tab order.
canReorganizeDimensions	Boolean			When this is true the user can reorganize the dimensions using drag and drop TODO: Document what events are fired when the reorg should happen
printHtml	String			This returns some HTML code that can be sent to a printer

Methods

Name	Description
getCellInfo	Returns a BiOlapGridCellInfo object based on the mouse coordinates
getCellInfoBounds	This returns the bounds of a cell relative to the inner edge of the OLAP grid (that is inside the outer border but not inside the headers/fixed area). This returns an object with left, top, width and height fields.
getFixedCornerHtmlCode	This returns the HTML code for the fixed corner of the OLAP grid. This may include both headers, row headers and some part of the body depending on whether there are any fixed rows/columns
getFixedLeftHtmlCode	This returns the HTML code for the left fixed part of the OLAP grid. This includes the row headers and any fixed columns
getFixedTopHtmlCode	This returns the HTML code for fixed top part of the OLAP grid. This includes the column headers as well as any fixed rows of the body
getHeadersHtmlCode	This returns the HTML code for header of the OLAP grid
getHtmlCode	This returns the HTML code for the body of the OLAP grid
getRowHeadersHtmlCode	This returns the HTML code for the row headers.
print	This prints the OLAP grid
updateContentSize	This is called when the size of the content has changed.
updateSize	This updates the sizes of different parts of the sub controls

Events

Name	Type	Bubbles	Descripton
dimensiondrop	BiOlapGridDragEvent		This is fired when a dimension of the current grid is dropped on another dimension. This can only happen if canReorganizeDimensions is true

Static Methods

None.

Static Fields

None.

Remarks

Method Details

getCellInfo

Returns a BiOlapGridCellInfo object based on the mouse coordinates

Syntax

object.getCellInfo
 (
 nOffsetX,nOffsetY
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nOffsetX	Number			The left postion relative to the OLAP grid
nOffsetY	Number			The top postion relative to the OLAP grid

Return Type

BiOlapGridCellInfo

getCellInfoBounds

This returns the bounds of a cell relative to the inner edge of the OLAP grid (that is inside the outer border but not inside the headers/fixed area). This returns an object with left, top, width and height fields.

Syntax

object.getCellInfoBounds
 (
 oCellInfo
 )
 

Parameters

Name	Type	Optional	Default	Descripton
oCellInfo	BiOlapGridCellInfo			The information about the cell to get the boundaries for

Return Type

Object

getFixedCornerHtmlCode

This returns the HTML code for the fixed corner of the OLAP grid. This may include both headers, row headers and some part of the body depending on whether there are any fixed rows/columns

Syntax

object.getFixedCornerHtmlCode
 (
 nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nWidth	Number			the width of the viewport
nHeight	Number			the height of the viewport

Return Type

String

getFixedLeftHtmlCode

This returns the HTML code for the left fixed part of the OLAP grid. This includes the row headers and any fixed columns

Syntax

object.getFixedLeftHtmlCode
 (
 nScrollTop,nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nScrollTop	Number			the distance from the top to start painting at
nWidth	Number			the width of the viewport
nHeight	Number			the height of the viewport

Return Type

String

getFixedTopHtmlCode

This returns the HTML code for fixed top part of the OLAP grid. This includes the column headers as well as any fixed rows of the body

Syntax

object.getFixedTopHtmlCode
 (
 nScrollLeft,nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nScrollLeft	Number			the distance from the left to start painting at
nWidth	Number			the width of the viewport
nHeight	Number			the height of the viewport

Return Type

String

getHeadersHtmlCode

This returns the HTML code for header of the OLAP grid

Syntax

object.getHeadersHtmlCode
 (
 nStartCol,nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nStartCol	Number			The column to start drawing at
nWidth	Number			The width of the viewport
nHeight	Number			The height of the viewport

Return Type

String

getHtmlCode

This returns the HTML code for the body of the OLAP grid

Syntax

object.getHtmlCode
 (
 nStartCol,nStartRow,nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nStartCol	Number			The column to start drawing at
nStartRow	Number			The row to start painting at
nWidth	Number			The width of the viewport
nHeight	Number			The height of the viewport

Return Type

String

getRowHeadersHtmlCode

This returns the HTML code for the row headers.

Syntax

object.getRowHeadersHtmlCode
 (
 nStartRow,nWidth,nHeight
 )
 

Parameters

Name	Type	Optional	Default	Descripton
nStartRow	Number			The row to start painting at
nWidth	Number			The width of the viewport
nHeight	Number			The height of the viewport

Return Type

String

print

This prints the OLAP grid

Syntax

object.print
 (
 
 )
 

Parameters

No arguments.

Return Type

void

updateContentSize

This is called when the size of the content has changed.

Syntax

object.updateContentSize
 (
 
 )
 

Parameters

No arguments.

Return Type

void

updateSize

This updates the sizes of different parts of the sub controls

Syntax

object.updateSize
 (
 
 )
 

Parameters

No arguments.

Return Type

void