Constructor
new FlattenedTreeDataSource(treeDataSource, options)
Base class for FlattenedTreeDataGridDataSource and FlattenedTreeTableDataSource
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
treeDataSource |
Object | the instance of TreeDataSource to flattened | |
options |
Object |
<optional> |
the options set on the FlattenedDataSource |
- Source:
Methods
-
_fetchRowsFromDescendents(range)
-
Fetch a range of rows from the underlying TreeDataSource using the fetchDescendents method.
Parameters:
Name Type Description range
Object the range of rows to fetch. This is the range in a flattened view. Properties
Name Type Description start
number the start of the range in a flattened view count
number the number of rows to fetch - Source:
-
collapse(rowKey)
-
Collapse the specified row.
Parameters:
Name Type Description rowKey
Object the key of the row to collapse - Source:
-
Destory()
-
Destory the data source.
- Source:
-
expand(rowKey)
-
Expand the specified row.
Parameters:
Name Type Description rowKey
Object the key of the row to expand - Source:
-
getExpandedKeys() → {Array.<Object>|string}
-
Retrieves the expanded row keys
- Source:
Returns:
an array of expanded row keys or 'all' if all rows are expanded.- Type
- Array.<Object> | string
-
getOption(option) → {Object}
-
Retreives the value of the specified option.
Parameters:
Name Type Description option
string the option to retrieve the value. - Source:
Returns:
the value of the specified option. Returns null if the value is null or if the option is not recognized.- Type
- Object
-
getWrappedDataSource() → {Object}
-
Retrieves the underlying TreeDataSource.
- Source:
Returns:
the underlying oj.TreeDataSource.- Type
- Object
-
handleEvent(eventType, event)
-
Handle the event
Parameters:
Name Type Description eventType
string event type event
Object event - Source:
-
Init()
-
Initializes the data source.
- Source:
Non-public Methods
-
<protected> _fetchRowsFromChildren(range)
-
Fetch a range of rows from the underlying TreeDataSource.
Parameters:
Name Type Description range
Object the range of rows to fetch. This is the range in a flattened view. Properties
Name Type Description start
number the start of the range in a flattened view count
number the number of rows to fetch - Source:
-
<protected> fetchRows(range)
-
Fetch a range of rows from the underlying data source. This is a convenient method that the subclasses should use to fetch from the underlying TreeDataSource. This method will take care of the index mapping between a flattened range to tree indexes.
Parameters:
Name Type Description range
Object the range of rows to fetch. This is the range in a flattened view. Properties
Name Type Description start
number the start of the range in a flattened view count
number the number of rows to fetch - Source:
-
<protected> getFetchedRange() → {Object}
-
Returns the currently fetched range.
- Source:
Returns:
the fetched range (start, end).- Type
- Object
-
<protected> getIndex(rowKey) → {number}
-
Determine the flattened index for the specified key
Parameters:
Name Type Description rowKey
Object the key to find the index - Source:
Returns:
the index representing the specified key. Returns -1 if the index cannot be found.- Type
- number
-
<protected> getKey(index) → {Object|null}
-
Determines the key for the specified flattened index
Parameters:
Name Type Description index
number the index in flattened view - Source:
Returns:
the key for the specified index. Returns null if the index has not been fetched yet or is invalid.- Type
- Object | null
-
<protected> handleExpandSuccess(rowKey, nodeSet, origCount)
-
Callback method to handle fetch success on expand operation.
Parameters:
Name Type Description rowKey
Object the key of the expanded row nodeSet
Object the node set that describes the children of the expanded row origCount
number the original count in the fetch request - Source:
-
<protected> handleMaxCountReached(range, callbacks)
-
Handles what happened when the maximum row count has been reached.
Parameters:
Name Type Description range
Object the range of the fetch request which caused the max count to be reached. callbacks
Object the callbacks of the fetch request which caused the max count to be reached. - Source:
-
<protected> insertMetadata(key, metadata)
-
A hook for FlattenedTreeDataSource to inject additional metadata into the NodeSet
Parameters:
Name Type Description key
Object the row key identifying the row metadata
Object the existing metadata to inject into - Source:
-
<protected> insertRows(insertAtIndex, insertAtKey, nodeSet)
-
Abstract method to insert a set of rows into the DataGrid/Table
Parameters:
Name Type Description insertAtIndex
number the flattened index of the node where the rows are inserted. insertAtKey
Object the key of the node where the rows are inserted (the parent key) nodeSet
Object the node set containing data/metadata of inserted rows - Source:
-
<protected> refresh()
-
Refresh the data source. Clear out any state.
- Source:
-
<protected> removeRows(rowKeys)
-
Abstract method to remove the specified rows in the DataGrid/Table
Parameters:
Name Type Description rowKeys
Array.<Object> an array of keys of the rows to be remove. - Source: