Usage
For additional information visit:
Final classes in JET
Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.
- See:
Properties:
Name | Type | Argument | Description |
---|---|---|---|
options.columns |
Array.<string> |
<optional> |
explicitly specifies columns to display and in what order. These columns must be a subset of attributes from Model. |
options.rowHeader |
string |
<optional> |
the key of the attribute designated as the row header |
Constructor
new CollectionDataGridDataSource(collection, options)
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 |
- See:
Properties:
Name | Type | Argument | Description |
---|---|---|---|
options.columns |
Array.<string> |
<optional> |
explicitly specifies columns to display and in what order. These columns must be a subset of attributes from Model. |
options.rowHeader |
string |
<optional> |
the key of the attribute designated as the row header |
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. 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. Properties:
Name Type Argument Description callbackObjects.error
Object <optional>
callbackObjects.success
Object <optional>
callbacks.error
function({status: Object}) the callback to invoke when fetch cells failed. callbacks.success
function({cellSet: Object}, {cellRanges: Array.<Object>}):undefined the callback to invoke when fetch cells completed successfully. cellRanges.axis
string the axis associated with this range where cells are fetched. Valid values are "row" and "column". cellRanges.count
number the size of the range for this axis in which the cells are fetched. cellRanges.start
number the start index of the range for this axis in which the cells are fetched. -
fetchHeaders(headerRange, callbacks, callbackObjects) : {undefined}
-
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 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. Properties:
Name Type Argument Description callbackObjects.error
Object <optional>
callbackObjects.success
Object <optional>
callbacks.error
function({status: Object}):undefined the callback to invoke when fetch cells failed. callbacks.success
function({startHeaderSet: Object}, {headerRange: Object}, {endHeaderSet: Object}):undefined 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. headerRange.axis
string the axis of the header that are fetched. Valid values are "row" and "column". headerRange.count
number the size of the range in which the header data are fetched. headerRange.start
number the start index of the range in which the header data are fetched. Returns:
- Type
- undefined
-
getCapability(feature) : {string|null}
-
Determines whether this CollectionDataGridDataSource supports certain feature.
Parameters:
Name Type Description feature
string the feature in which its capabilities is inquired. Currently the only valid feature is "sort" and "move" 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". 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:
"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:
Returns:
Returns false if event is cancelled
- Type
- boolean
-
indexes(keys) : {Promise.<Object>}
-
Returns the row and column index based on the keys. In a paging case returns the index on the page, not the absolute index in the array.
Parameters:
Name Type Description keys
Object the key for each axis Properties:
Returns:
a promise object containing the index for each axis
- Type
- Promise.<Object>
-
Init : {undefined}
-
Initializes the instance.
- Inherited From:
Returns:
- Type
- undefined
-
keys(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.column
number | null the index for the column axis indexes.row
number | null the index for the row axis Returns:
a Promise object which upon resolution will pass in an object containing the keys for each axis
- Type
- Promise.<Object>
-
move(rowToMove, referenceRow, position, callbacks, callbackObjects) : {undefined}
-
Move a model to a new index in the collection, if referenceRow is null adds to the end
Parameters:
Name Type Argument Description rowToMove
any the key of the model that should be moved referenceRow
any 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
Object <optional>
the callbacks to be invoke upon completion of the move operation. callbackObjects
Object <optional>
the object in which the callback function is invoked on. Properties:
Name Type Argument Description callbackObjects.error
Object <optional>
callbackObjects.success
Object <optional>
callbacks.error
function({status: Object}):undefined the callback to invoke when sort failed. callbacks.success
function():undefined the callback to invoke when the sort completed successfully. Returns:
- Type
- undefined
-
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:
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:
Returns:
- Type
- void
-
sort(criteria, callbacks, callbackObjects) : {undefined}
-
Performs a sort on the data source.
Parameters:
Name Type Argument Description criteria
Object | null the sort criteria. callbacks
Object <optional>
the callbacks to be invoke upon completion of the sort operation. callbackObjects
Object <optional>
the object in which the callback function is invoked on. Properties:
Name Type Argument Description callbackObjects.error
Object <optional>
callbackObjects.success
Object <optional>
callbacks.error
function({status: Object}):undefined the callback to invoke when sort failed. callbacks.success
function():undefined the callback to invoke when the sort completed successfully. criteria.axis
string The axis in which the sort is performed, valid values are "row", "column" criteria.direction
string the sort direction, valid values are "ascending", "descending", "none" (default) criteria.key
any The key that identifies which header to sort Returns:
- Type
- undefined