Final Class: CubeDataGridDataSource

Methods

fetchCells(cellRange, callbacks, callbackObjects) : {void}

Parameters:

Name	Type	Argument	Description
cellRange	Array.<Object>		Information about the cell range. A cell range is defined by an array of range info for each axis, where each range contains three properties: axis, start, count. axis: the axis associated with this range where cells are fetched. Valid values are "row" and "column". start: the start index of the range for this axis in which the cells are fetched. count: count the size of the range for this axis in which the cells are fetched.
callbacks	Object		the callbacks to be invoke when fetch cells operation is completed. The valid callback types are "success" and "error"
callbackObjects	Object	<optional>	the object in which the callback function is invoked on. This is optional. You can specify the callback object for each callbacks using the "success" and "error" keys.

Properties:

Name	Type	Argument	Description
callbacks.success	function({cellSet: Object}, {cellRange: Object}):void		the callback to invoke when fetch cells completed successfully. The passed arguments are CellSet and the cellRange
callbacks.error	function({status: Object}):void		the callback to invoke when fetch cells failed.
callbackObjects.success	Object	<optional>
callbackObjects.error	Object	<optional>

Returns:

Type

void

fetchHeaders(headerRange, callbacks, callbackObjects) : {void}

Fetch a range of headers from the data source.

Parameters:

Name	Type	Argument	Description
headerRange	Object		information about the header range, it must contain the following properties: axis, start, count
callbacks	Object		the optional callbacks to be invoke when fetch headers operation is completed. The valid callback types are "success" and "error"
callbackObjects	Object	<optional>	the object in which the callback function is invoked on. This is optional. You can specify the callback object for each callbacks using the "success" and "error" keys.

Properties:

Name	Type	Argument	Description
headerRange.axis	string		the axis of the header that are fetched. Valid values are "row" and "column"
headerRange.start	number		the start index of the range in which the header data are fetched
headerRange.count	number		the size of the range in which the header data are fetched
callbacks.success	function({startHeaderSet: Object}, {headerRange: Object}, {endHeaderSet: Object}):void		the callback to invoke when fetch headers completed successfully. The function takes three parameters: HeaderSet object representing start headers, headerRange object passed into the original fetchHeaders call, and a HeaderSet object representing the end headers along the axis.
callbacks.error	function({status: Object}):void		the callback to invoke when fetch cells failed.
callbackObjects.success	Object	<optional>
callbackObjects.error	Object	<optional>

Returns:

Type

void

getCapability(feature) : {string|null}

Determines whether this DataGridDataSource supports certain feature.

Parameters:

Name	Type	Description
feature	string	the feature in which its capabilities is inquired. Currently the only valid feature is "sort".

Returns:

the name of the feature. For "sort", the valid return values are: "full", "none", "row", "column". For "move", the valid return values are: "row", "none". Returns null if the feature is not recognized.

Type

string | null

getCount(axis) : {number}

Returns the total number of rows or columns. If the value return is not >= 0 then it is automatically assumed that the total count is unknown.

Parameters:

Name	Type	Description
axis	string	the axis in which we inquire for the total count. Valid values are "row" and "column".

Returns:

the total number of rows/columns.

Type

number

getCountPrecision(axis) : {string}

Returns whether the total count returned in getCount function is an actual or an estimate.

Parameters:

Name	Type	Description
axis	string	the axis in which we inquire whether the total count is an estimate. Valid values are "row" and "column".

Returns:

"exact" if the count returned in getCount function is the actual count, "estimate" if the count returned in getCount function is an estimate. The default value is "exact".

Type

string

handleEvent(eventType, event) : {boolean}

Handle the event

Parameters:

Name	Type	Description
eventType	string	event type
event	Object	event

Inherited From:

• oj.EventSource#handleEvent

Returns:

Returns false if event is cancelled

Type

boolean

indexes(indexes) : {Promise.<Object>}

Returns the keys based on the indexes.

Parameters:

Name	Type	Description
indexes	Object	the index for each axis

Properties:

Name	Type	Description
indexes.row	number	the index for the row axis
indexes.column	number	the index for the column axis

Returns:

a Promise object which when resolved returns an object containing the index for each axis

Type

Promise.<Object>

Init : {undefined}

Initializes the instance.

Inherited From:

• oj.DataSource#Init

Returns:

Type

undefined

keys(keys) : {Promise.<Object>}

Returns the row and column index based on the keys.

Parameters:

Name	Type	Description
keys	Object	the key for each axis

Properties:

Name	Type	Description
keys.row	number	the key for the row axis
keys.column	number	the key for the column axis

Returns:

a Promise object which when resolved returns an object containing the key for each axis

Type

Promise.<Object>

moveOK(rowToMove, referenceRow, position) : {string}

Checks whether a move operation is valid.

Parameters:

Name	Type	Description
rowToMove	any	the key of the row to move
referenceRow	any	the key of the reference row which combined with position are used to determine the destination of where the row should moved to.
position	string	The position of the moved row relative to the reference row. Valid values are: "before", "after".

Returns:

returns "valid" if the move is valid, "invalid" otherwise.

Type

string

off(eventType, eventHandler) : {void}

Detach an event handler.

Application can call this if it no longer wants to be notified of an event that it has attached an handler to using the on method.

Parameters:

Name	Type	Description
eventType	string	eventType
eventHandler	function(Object)	event handler function

Inherited From:

• oj.EventSource#off

Returns:

Type

void

on(eventType, eventHandler) : {void}

Attach an event handler.

Application can call this if it wants to be notified of an event. It can call the off method to detach the handler when it no longer wants to be notified.

Parameters:

Name	Type	Description
eventType	string	eventType
eventHandler	function(Object)	event handler function

Inherited From:

• oj.EventSource#on

Returns:

Type

void

setCube(cube) : {undefined}

Set a new cube on the data source

Parameters:

Name	Type	Description
cube	oj.Cube

Returns:

Type

undefined

setPage(indices) : {undefined}

Pin any axes beyond the row and column to specific index values (to allow the idea of "paging" through a cube)

Parameters:

Name	Type	Description
indices	Array.<oj.CubeDataGridDataSource.Indices>	an array of objects each containing an 'axis' attribute and a zero-based 'index' attribute giving the index to "pin" the axis to.

Returns:

Type

undefined

Type Definitions

Indices

Object in setPage indices parameter

Properties:

Name	Type
axis	number
index	number