Class: CollectionDataGridDataSource

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

oj. CollectionDataGridDataSource extends oj.DataGridDataSource

Version:
  • 3.2.0

Constructor

new CollectionDataGridDataSource(collection, options)

An OJ Collection based implementation of the DataGridDataSource.
Parameters:
Name Type Argument Description
collection Object the oj collection to adapter the DataGridDataSource
options Object <optional>
optional settings on this oj collection data source
Properties
Name Type Argument Description
rowHeader string <optional>
the key of the attribute designated as the row header
columns Array.<string> <optional>
explicitly specifies columns to display and in what order. These columns must be a subset of attributes from Model.
Source:

Methods

#fetchCells(cellRanges, callbacks, callbackObjects)

Fetch a range of cells from the data source.
Parameters:
Name Type Argument Description
cellRanges 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.
Properties
Name Type Description
axis string the axis associated with this range where cells are fetched. Valid values are "row" and "column".
start number the start index of the range for this axis in which the cells are fetched.
count number 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".
Properties
Name Type Description
success function(CellSet) the callback to invoke when fetch cells completed successfully.
error function({status: Object}) the callback to invoke when fetch cells failed.
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.
Source:

#fetchHeaders(headerRange, callbacks, callbackObjects)

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.
Properties
Name Type Description
axis string the axis of the header that are fetched. Valid values are "row" and "column".
start number the start index of the range in which the header data are fetched.
count number the size of the range in which the header data are fetched.
callbacks Object the callbacks to be invoke when fetch headers operation is completed. The valid callback types are "success" and "error".
Properties
Name Type Description
success function(HeaderSet, headerRange, endHeaderSet) the callback to invoke when fetch headers completed successfully. The function takes three paramaters: HeaderSet object representing start headers, headerRange object passed into the original fetchHeaders call, and a HeaderSet object representing the end headers along the axis.
error function({status: Object}) the callback to invoke when fetch cells failed.
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.
Source:

#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".
Source:
Returns:
the name of the feature. For sort, the valid return values are: "full", "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. In the case of paging returns the total number of rows/colums on the page.
Parameters:
Name Type Description
axis string the axis in which we inquire for the total count. Valid values are "row" and "column".
Source:
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".
Source:
Returns:
"actual" 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 "actual".
Type
string

handleEvent(eventType, event) → {boolean}

Handle the event
Parameters:
Name Type Description
eventType string event type
event Object event
Inherited From:
Source:
Returns:
Returns false if event is cancelled
Type
boolean

#indexes(keys) → {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
row Object the key for the row axis
column Object the key for the column axis
Source:
Returns:
a Promise object which upon resolution will pass in an object containing the indexes for each axis
Type
Object

Init()

Initial the OJ collection based data source.
Source:

keys(indexes) → {Object}

Returns the keys based on the indexes.
Parameters:
Name Type Description
indexes Object the index for each axis
Properties
Name Type Description
row Object the index for the row axis
column Object the index for the column axis
Source:
Returns:
a Promise object which upon resolution will pass in an object containing the keys for each axis
Type
Object

#move(moveKey, atKey, position, callbackObjects)

Move a model to a new index in the collection, if atKey is null adds to the end
Parameters:
Name Type Argument Description
moveKey Object the key of the model that should be moved
atKey Object the key of the model that the moved model should be inserted before or after
position string The position of the moved row relative to the reference row. Valid values are: "before", "after"
callbacks.success function() the callback to invoke when the move completed successfully.
callbacks.error function({status: Object}) the callback to invoke when move failed.
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" properties.
Source:

#moveOK(rowToMove, referenceRow, position) → {string}

Checks whether a move operation is valid.
Parameters:
Name Type Description
rowToMove Object the key of the row to move
referenceRow Object 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".
Source:
Returns:
returns "valid" if the move is valid, "invalid" otherwise.
Type
string

off(eventType, eventHandler)

Detach an event handler
Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Source:

on(eventType, eventHandler)

Attach an event handler
Parameters:
Name Type Description
eventType string eventType
eventHandler function(Object) event handler function
Inherited From:
Source:

#sort(criteria, callbacks, callbackObjects)

Performs a sort on the data source.
Parameters:
Name Type Argument Description
criteria Object the sort criteria.
Properties
Name Type Description
axis string The axis in which the sort is performed, valid values are "row", "column"
key Object The key that identifies which header to sort
direction string the sort direction, valid values are "ascending", "descending", "none" (default)
callbacks Object the callbacks to be invoke upon completion of the sort operation. The callback properties are "success" and "error".
Properties
Name Type Description
success function() the callback to invoke when the sort completed successfully.
error function({status: Object}) the callback to invoke when sort failed.
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" properties.
Source: