Constructor
new JsonTreeDataSource(data)
A json object based implementation of the TreeDataSource.
Parameters:
Name | Type | Description |
---|---|---|
data |
Object | the json object |
Methods
-
_createTreeDataSource(c, target, source, depth)
-
Returns tree based structure/object from json data.
Parameters:
Name Type Argument Description c
Object an object to keep track of the count target
Object the final tree structure. source
Object the json object. depth
number <optional>
used recursively for depth calculation. - Source:
Returns:
target -
fetchChildren(parentKey, range, callbacks, options)
-
Fetch the children
Parameters:
Name Type Argument Description parentKey
Object the parent key. Specify null if fetching children from the root. range
Object information about the range, it must contain the following properties: start, count. Properties
Name Type Description start
number the start index of the range in which the children are fetched. count
number the size of the range in which the children are fetched. callbacks
Object the callbacks to be invoke when fetch children operation is completed. The valid callback types are "success" and "error". Properties
Name Type Description success
function(oj.JsonNodeSet) the callback to invoke when fetch completed successfully. error
function({status: Object}) the callback to invoke when fetch children failed. options
Object <optional>
optional parameters for this operation. Properties
Name Type Argument Description queueOnly
boolean <optional>
true if this fetch request is to be queued and not execute yet. The implementation must maintain the order of the fetch operations. When queueOnly is false/null/undefined, any queued fetch operations are then flushed and executed in the order they are queued. This flag is ignored if the datasource does not support batching. - Source:
-
fetchDescendants(parentKey, callbacks, maxCount)
-
Fetch all children and their children recursively from a specified parent.
Parameters:
Name Type Argument Description parentKey
Object the parent key. Specify null to fetch everything from the root (i.e. expand all) callbacks
Object the callbacks to be invoke when fetch children operation is completed. The valid callback types are "success" and "error". Properties
Name Type Description success
function(oj.JsonNodeSet) the callback to invoke when fetch completed successfully. error
function({status: Object}) the callback to invoke when fetch children failed. maxCount
Object <optional>
the maximum number of children to fetch. If a non-positive number is specified, then the value is ignored and there is no maximum fetch count. - Source:
-
getCapability(feature) → {string|null}
-
Determines whether this TreeDataSource supports the specified feature.
Parameters:
Name Type Description feature
string the feature in which its capabilities is inquired. Currently the valid features "sort", "move", "fetchDescendants", "batchFetch" - Source:
Returns:
the name of the feature. Returns null if the feature is not recognized. For "sort", the valid return values are: "default", "none". For "fetchDescendants", the valid return values are: "enable", "disable", "suboptimal". For "move", the valid return values are: "default", "none". For "batchFetch", the valid return values are: "enable", "disable".- Type
- string | null
-
getChildCount(parentKey) → {number}
-
Returns the number of children for a specified parent. If the value returned is not >= 0 then it is automatically assumed that the child count is unknown.
Parameters:
Name Type Description parentKey
Object the parent key. Specify null if inquiring child count of the root. - Source:
Returns:
the number of children for the specified parent.- Type
- number
-
getSortCriteria() → {Object}
-
Returns the current sort criteria of the tree data.
- Source:
Returns:
the current sort criteria. It should contain the following properties: key, direction where criteria.key the key identifying the attribute (column) to sort on. Value is null if it's not sorted. criteria.direction the sort direction, valid values are "ascending", "descending", "none" (default)- Type
- Object
-
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()
-
Initial the json object based data source.
- Source:
-
move(nodeToMove, referenceNode, position)
-
Moves a node from one location to another (different position within the same parent or a completely different parent)
Parameters:
Name Type Description nodeToMove
Object the key of the node to move referenceNode
Object the key of the reference node which combined with position are used to determine the destination of where the node should moved to. position
number | string The position of the moved node relative to the reference node. This can be a string: "before", "after", "inside", "first", "last", or the zero based index to position the element at a specific point among the reference node's current children. callbacks.success
function() the callback to invoke when the move completed successfully. callbacks.error
function({status: Object}) the callback to invoke when move failed. - 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
number | string The position of the moved row relative to the reference row. This can be a string: "before", "after", "inside", "first", "last", or the zero based index to position the element at a specific point among the reference row's current children. - 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)
-
Performs a sort operation on the tree data.
Parameters:
Name Type Description criteria
Object the sort criteria. It must contain the following properties: key, direction Properties
Name Type Description key
Object the key identifying the attribute (column) to sort on {string} criteria.direction the sort direction, valid values are "ascending", "descending", "none" (default) callbacks.success
function() the callback to invoke when the sort completed successfully. callbacks.error
function({status: Object}) the callback to invoke when sort failed. - Source: