Caplin Trader 5.1.0

Class: module:ct-grid/GridScrollPane

module:ct-grid/GridScrollPane(gridView, dimensions, scrollBarCtor)

new module:ct-grid/GridScrollPane(gridView, dimensions, scrollBarCtor)

All scrolling behaviour in GridView is handled by this class. Header tracking should be done by adding the GridHeader element as an additional element.

Parameters:
Name Type Description
gridView module:ct-grid/GridView

the grid view
dimensions Map

Map of scrolling widths & heights
scrollBarCtor function

ScrollBar constructor. If omitted native ScrollBar will be used.

Methods

disableScrolling()

Disables scrolling by ignoring scroll events and hiding scrollbars

enableScrolling()

Enables scrolling if it was previously disabled

getNumberOfDisplayedRows() → {int}

Returns the number of displayed rows.

Returns:

the number of displated rows within the scroll pane.

Type
int

getRowElement(rowIndex) → {DOMElement}

Returns the row element at the specified index.

Parameters:
Name Type Description
rowIndex int

the index of the row element to get.
Returns:

the row element at the specified index.

Type
DOMElement

getScrollPaneContent() → {DOMElement}

Returns the content element of the scroll pane.

Returns:

The content element.

Type
DOMElement