Class jQuery.fn.jMatrixBrowse
jMatrixBrowse
Defined in: jMatrixBrowse.js.
Constructor Attributes | Constructor Name and Description |
---|---|
jMatrixBrowse - a jQuery plugin to create large draggable(like Google Maps)
matrices.
|
Method Attributes | Method Name and Description |
---|---|
<inner> |
Binds shortcuts for browsing.
|
<inner> |
checkAndRepositionCellCol(cellElements, container, col, overflow)
Checks if the given column is overflowing and repositions if necessary.
|
<inner> |
checkAndRepositionCellRow(cellElements, container, row, overflow)
Checks if the given row is overflowing and repositions if necessary.
|
<inner> |
Check and resposition cells that are overflowing.
|
<inner> |
checkAndRepositionColumnHeader(header)
Check and resposition headers according to cell positions.
|
<inner> |
Check and resposition headers according to cell positions.
|
<inner> |
checkAndRepositionRowHeader(header)
Check and resposition headers according to cell positions.
|
<inner> |
computeNewCellCoordinates(overflow)
Computes the new cell coordinates when a drag results in overflow.
|
<inner> |
getColIndexForReload(direction)
Computes the col index needed for reload.
|
<inner> |
getRowIndexForReload(direction)
Computes the row index needed for reload.
|
<inner> |
init(elem)
Initialize the jMatrixBrowse.
|
<inner> |
isValidDrag(overflow)
Check if the drag is valid.
|
<inner> |
Reload column data on change of matrix.
|
<inner> |
Reload row headers on change of matrix.
|
<inner> |
Reload data on change of matrix.
|
Reload data in the matrix for the visible window.
|
|
<inner> |
Reload row and column headers on change of matrix.
|
<inner> |
Reload row and column data on change of matrix.
|
<inner> |
Reload row data on change of matrix.
|
<inner> |
Reload column headers on change of matrix.
|
<inner> |
updateCellForReload(cell, rowIndex, colIndex, newCell, newRowNumber, newColNumber)
Updates the cell content for reload based on the reload strategy.
|
<inner> |
updateCellsForReload(rowIndex, colIndex, cells)
Updates the cells which have been reloaded for the given row and col indices.
|
Class Detail
jQuery.fn.jMatrixBrowse()
jMatrixBrowse - a jQuery plugin to create large draggable(like Google Maps)
matrices.
Method Detail
<inner>
bindShortcuts()
Binds shortcuts for browsing.
<inner>
{boolean}
checkAndRepositionCellCol(cellElements, container, col, overflow)
Checks if the given column is overflowing and repositions if necessary.
- Parameters:
- {matrix} cellElements
- - The matrix of DOM objects representing cells.
- {jQuery Object} container
- - The container against which to check the overflow.
- {Number} col
- - Index of column to check the overflow for.
- {Number} overflow
- - Type of the overflow to check for.
- Returns:
- {boolean} true if any cells were repositioned. false otherwise.
<inner>
{boolean}
checkAndRepositionCellRow(cellElements, container, row, overflow)
Checks if the given row is overflowing and repositions if necessary.
- Parameters:
- {matrix} cellElements
- - The matrix of DOM objects representing cells.
- {jQuery Object} container
- - The container against which to check the overflow.
- {Number} row
- - Index of row to check the overflow for.
- {Number} overflow
- - Type of the overflow to check for.
- Returns:
- {boolean} true if any cells were repositioned. false otherwise.
<inner>
checkAndRepositionCells()
Check and resposition cells that are overflowing.
<inner>
checkAndRepositionColumnHeader(header)
Check and resposition headers according to cell positions.
- Parameters:
- header
- - column header container
<inner>
checkAndRepositionHeaders()
Check and resposition headers according to cell positions.
<inner>
checkAndRepositionRowHeader(header)
Check and resposition headers according to cell positions.
- Parameters:
- header
- - row header container
<inner>
computeNewCellCoordinates(overflow)
Computes the new cell coordinates when a drag results in overflow.
- Parameters:
- {Number} overflow
- - Type of the overflow.
<inner>
{Object}
getColIndexForReload(direction)
Computes the col index needed for reload.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} direction
- - direction of overflow corresponding to the update
- Returns:
- {Object} colIndex - col1, col2 and colsNotInBound
<inner>
{Object}
getRowIndexForReload(direction)
Computes the row index needed for reload.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} direction
- - direction of overflow corresponding to the update
- Returns:
- {Object} rowIndex - row1, row2 and rowsNotInBound
<inner>
init(elem)
Initialize the jMatrixBrowse.
- Parameters:
- {jQuery object} elem
- - the element to which to attach the jMatrixBrowse.
<inner>
{boolean}
isValidDrag(overflow)
Check if the drag is valid.
- Parameters:
- {Number} overflow
- - Type of the overflow to check for.
- Returns:
- {boolean} true if the drag is valid.
<inner>
reloadColData()
Reload column data on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
reloadColHeaders()
Reload row headers on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
reloadData()
Reload data on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
reloadData()
Reload data in the matrix for the visible window.
<inner>
reloadHeaders()
Reload row and column headers on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
reloadMatrixData()
Reload row and column data on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
reloadRowData()
Reload row data on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
reloadRowHeaders()
Reload column headers on change of matrix.
- Parameters:
- {Number} event.currentCell
- - currentCell at the top left
- {Number} event.previousCell
- - previousCell at the top left
- {string} event.direction
- - direction of drag that triggered the change
<inner>
updateCellForReload(cell, rowIndex, colIndex, newCell, newRowNumber, newColNumber)
Updates the cell content for reload based on the reload strategy.
- Parameters:
- {jQuery Object} cell
- - cell to be replaced/reloaded.
- {Number} rowIndex
- - row index of the cell to be replaced.
- {Number} colIndex
- - column index of the cell to be replaced.
- {jQuery Object} newCell
- - cell to be replaced with.
- {Number} newRowNumber
- - new row number of the cell.
- {Number} newColNumber
- - new column number of the cell.
<inner>
updateCellsForReload(rowIndex, colIndex, cells)
Updates the cells which have been reloaded for the given row and col indices.
- Parameters:
- {Object} rowIndex
- - row1 and row2 for the request that was made.
- {Object} colIndex
- - col1 and col2 for the request that was made.
- {Array} cells
- - Array of Array of the response data.