Class Rico.Buffer.Base
Defines the static buffer class (no AJAX).
Loads buffer with data that already exists in the document as an HTML table or passed via javascript.
Also serves as a base class for AJAX-enabled buffers.
Defined in: <ricoLiveGrid.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Rico.Buffer.Base(dataTable, options)
|
| Method Attributes | Method Name and Description |
|---|---|
|
appendRows(cnt)
|
|
|
bufferRow(windowRow)
takes a window row index and returns the corresponding buffer row index
|
|
|
clear()
|
|
|
deleteRows(rowIndex, cnt)
|
|
|
dom2jstable(rowsElement)
|
|
|
dom2jstableAttr(rowsElement, firstRow)
|
|
|
endPos()
|
|
|
exportAllRows(populate, finish)
|
|
|
fetch(offset)
|
|
|
getCell(bufRow, col)
|
|
|
getRows(start, count)
|
|
|
getValue(bufRow, col)
|
|
|
getWindowAttr(windowRow, col)
|
|
|
getWindowCell(windowRow, col)
|
|
|
getWindowValue(windowRow, col)
|
|
|
insertRow(beforeRowIndex)
|
|
|
isInRange(position)
|
|
|
isVisible(bufRow)
|
|
|
loadRows(jstable)
|
|
|
loadRowsFromArray(array2D)
|
|
|
loadRowsFromTable(tableElement, firstRow)
|
|
|
nan2zero(n)
|
|
|
registerGrid(liveGrid)
|
|
|
setTotalRows(newTotalRows)
|
|
|
setValue(bufRow, col, newval, newstyle)
|
|
|
setWindow(start, count)
|
|
|
setWindowValue(windowRow, col, newval)
|
|
|
sortBuffer(colnum)
|
|
|
sortFunc(coltype)
|
|
Method Detail
appendRows(cnt)
- Parameters:
- cnt
applyFilters()
bufferRow(windowRow)
takes a window row index and returns the corresponding buffer row index
- Parameters:
- windowRow
clear()
deleteRows(rowIndex, cnt)
- Parameters:
- rowIndex
- cnt
dom2jstable(rowsElement)
- Parameters:
- rowsElement
dom2jstableAttr(rowsElement, firstRow)
- Parameters:
- rowsElement
- firstRow
endPos()
exportAllRows(populate, finish)
- Parameters:
- populate
- finish
fetch(offset)
- Parameters:
- offset
getCell(bufRow, col)
- Parameters:
- bufRow
- col
getRows(start, count)
- Parameters:
- start
- count
getValue(bufRow, col)
- Parameters:
- bufRow
- col
getWindowAttr(windowRow, col)
- Parameters:
- windowRow
- col
getWindowCell(windowRow, col)
- Parameters:
- windowRow
- col
- Returns:
- buffer cell at the specified visible row/col index
getWindowValue(windowRow, col)
- Parameters:
- windowRow
- col
insertRow(beforeRowIndex)
- Parameters:
- beforeRowIndex
isInRange(position)
- Parameters:
- position
isVisible(bufRow)
- Parameters:
- bufRow
- Returns:
- true if bufRow is currently visible in the grid
loadRows(jstable)
- Parameters:
- jstable
loadRowsFromArray(array2D)
- Parameters:
- array2D
loadRowsFromTable(tableElement, firstRow)
- Parameters:
- tableElement
- firstRow
nan2zero(n)
- Parameters:
- n
registerGrid(liveGrid)
- Parameters:
- liveGrid
setTotalRows(newTotalRows)
- Parameters:
- newTotalRows
setValue(bufRow, col, newval, newstyle)
- Parameters:
- bufRow
- col
- newval
- newstyle
setWindow(start, count)
- Parameters:
- start
- count
setWindowValue(windowRow, col, newval)
- Parameters:
- windowRow
- col
- newval
sortBuffer(colnum)
- Parameters:
- colnum
sortFunc(coltype)
- Parameters:
- coltype
visibleRows()
- Returns:
- a 2D array of buffer data representing the rows that are currently visible on the grid