Class: TableDataSource

Oracle® JavaScript Extension Toolkit (JET)
3.2.0

E87541-01

QuickNav

Fields

oj. TableDataSource extends oj.DataSource

Version:
  • 3.2.0
Abstract object representing data used by table component. Implementations of TableDataSource must implement all of the functions documented here.

Constructor

new TableDataSource(data, options)

Parameters:
Name Type Argument Description
data Object data supported by the components
options Object <optional>
Options for the TableDataSource
Source:

Fields

<static> EventType :string

Events which are published by TableDataSource. Any custom TableDataSource implementation must publish the corresponding events.
Properties:
Name Type Default Description
ADD string add Triggered when a Row has been added to a TableDataSource

The event payload contains:

dataAn array of raw row data
keysAn array of key values for the rows
indexesAn array of index values for the rows in post-insert sorted order
REMOVE string remove Triggered when a Row has been removed from a TableDataSource

The event payload contains:

dataAn array of raw row data
keysAn array of key values for the rows
indexesAn array of index values for the rows in pre-remove sorted order
RESET string reset Triggered when a TableDataSource has been reset
REFRESH string refresh Triggered when a TableDataSource has been refreshed
SORT string sort Triggered when a TableDataSource has been sorted

The event payload contains:

headerthe key of the header which was sorted on
directionthe direction of the sort ascending/descending
CHANGE string change Triggered when a Row's attributes have been changed

The event payload contains:

dataAn array of raw row data
keysAn array of key values for the rows
indexesAn array of index values for the rows
REQUEST string request Triggered when a TableDataSource has sent a fetch request. It is expected that a component using TableDataSource will go into a busy state upon receiving this event. The event payload contains:

startIndexThe start index at which the fetch was invoked
SYNC string sync Triggered when a TableDataSource has been updated by a fetch. It is expected that a component using TableDataSource will exit busy state upon completion of rendering after receiving this event.

The event payload contains:

dataAn array of raw row data
keysAn array of key values for the rows
startIndexThe start index at which the fetch occurred
ERROR string error Triggered when an error occurred on the TableDataSource
Source:

sortCriteria :{Object} criteria the sort criteria.

The sort criteria. Whenever sort() is called with the criteria parameter, that value is copied to this property. If sort() is called with empty sort criteria then the criteria set in this property is used.
Properties:
Name Type Description
criteria.key Object The key that identifies which field to sort
criteria.direction string the sort direction, valid values are "ascending", "descending", "none" (default)
Source:

Methods

#at(index, options) → {Promise}

Return the row data found at the given index.
Parameters:
Name Type Argument Description
index number Index for which to return the row data.
options Object <optional>
Options to control the at.
Properties
Name Type Description
fetchSize number fetch size to use if the call needs to fetch more records from the server, if virtualized. Overrides the overall fetchSize setting

Source:
Returns:
Promise resolves to a compound object which has the structure below. If the index is out of range, Promise resolves to null.

dataThe raw row data
indexThe index for the row
keyThe key value for the row
Type
Promise

#fetch(options) → {Promise}

Fetch the row data.
Parameters:
Name Type Argument Description
options Object <optional>
Options to control fetch
Properties
Name Type Description
startIndex number The index at which to start fetching records.
silent boolean If set, do not fire a sync event.
Source:
Returns:
Promise object resolves to a compound object which contains an array of row data objects, an array of ids, and the startIndex triggering done when complete.

The structure of the resolved compound object is:

dataAn array of raw row data
keysAn array of key values for the rows
startIndexThe startIndex for the returned set of rows
Type
Promise

#get(id, options) → {Promise}

Return the first row data whose id value is the given id
Parameters:
Name Type Argument Description
id string ID for which to return the row data, if found.
options Object <optional>
Options to control the get.
Properties
Name Type Description
fetchSize number fetch size to use if the call needs to fetch more records from the server, if virtualized. Overrides the overall fetchSize setting

Source:
Returns:
Promise which resolves to a compound object which has the structure below where the id matches the given id. If none are found, resolves to null.

dataThe raw row data
indexThe index for the row
keyThe key value for the row
Type
Promise

#getCapability(feature) → {string|null}

Determines whether this TableDataSource 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

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

#Init()

Initializes the instance.
Source:

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) → {Promise}

Performs a sort on the data source. Null criteria clears the existing sort.
Parameters:
Name Type Description
criteria Object the sort criteria.
Properties
Name Type Description
key Object The key that identifies which field to sort
direction string the sort direction, valid values are "ascending", "descending", "none" (default)
Source:
Returns:
promise object triggering done when complete.
Type
Promise

#totalSize() → {number}

Return the total size of data available, including server side if not local.
Source:
Returns:
total size of data
Type
number

#totalSizeConfidence() → {string}

Returns the confidence for the totalSize value.
Source:
Returns:
"actual" if the totalSize is the time of the fetch is an exact number "estimate" if the totalSize is an estimate "atLeast" if the totalSize is at least a certain number "unknown" if the totalSize is unknown
Type
string