Class Index | File Index

Classes


Class jMatrixBrowseNs.BackgroundDataManager

BackgroundDataManager
Defined in: BackgroundDataManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Manages backgorund loading for jMatrixBrowse.
Method Summary
Method Attributes Method Name and Description
<inner>  
Begins loading all the data into the dom.
<inner>  
combineResponses(requests, responses, request)
Combines the responses from various api requests and backgrounds to form one matrix of cells.
<inner>  
Forms the requests that should be made to the api to get the remaining cells.
 
Gets the curernt window that has been loaded by the background data manager.
Class Detail
jMatrixBrowseNs.BackgroundDataManager(elem, api, config)
Manages backgorund loading for jMatrixBrowse.
Parameters:
{jQuery Object} elem
- element that initiated jMatrixBrowse.
{Object} api
- api manager for making requests to api.
config
Method Detail
<inner> beginLoadingData()
Begins loading all the data into the dom. This creates a new container to hold the data inside elem.

<inner> {ArrayOfArray} combineResponses(requests, responses, request)
Combines the responses from various api requests and backgrounds to form one matrix of cells.
Parameters:
{Array} requests
Array of requests that were made to the api.
{Array} responses
Responses received from the api.
{Object} request
One big request for which we want the data.
Returns:
{ArrayOfArray} Array of array of cells in the requested window.

<inner> {Array} getRequiredRequests(request)
Forms the requests that should be made to the api to get the remaining cells.
Parameters:
{Object} request
The requested window.
Returns:
{Array} Array of requests to be made to api to get cells not already in background.

{Object} getWindowLoaded()
Gets the curernt window that has been loaded by the background data manager.
Returns:
{Object} windowLoaded - window (row1, col1, row2, col2) of cells that have been loaded.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Aug 09 2012 00:23:53 GMT+0200 (CEST)