Constructor
new JsonNodeSet()
A JsonNodeSet represents a collection of nodes. The JsonNodeSet is an object returned by the success callback
of the fetchChildren method on TreeDataSource.
- Source:
Methods
-
getChildNodeSet(index) → {oj.JsonNodeSet|null}
-
Gets the node set child of the specified index.
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the child node set - Source:
- ojdatacollection-common/JsonNodeSet.js, line 133
Returns:
the child node set representing the child tree data.- Type
- oj.JsonNodeSet | null
-
getCount() → {number}
-
Gets the actual count of the result set.
- Source:
Returns:
the actual count of the result set.- Type
- number
-
getData(index) → {Object}
-
Gets the data of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds.
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the data from. - Source:
Returns:
the data for the specified index. oj.RowData should be returned for data that represents a row with a number of columns.- Type
- Object
-
getMetadata(index) → {Object}
-
Gets the metadata of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds. The metadata that the data source must return are: 1) key - Object, the key of the node/row. 2) leaf - boolean, true if it's a leaf, false otherwise. 3) depth - number, the depth of the node/row.
Parameters:
Name Type Description index
number the index of the node/row in which we want to retrieve the metadata from. - Source:
Returns:
the metadata object for the specific index.- Type
- Object
-
getParent() → {Object}
-
Gets the parent key for this result set.
- Source:
Returns:
the parent key for this result set.- Type
- Object
-
getStart() → {number}
-
Gets the start index of the result set.
- Source:
Returns:
the start index of the result set.- Type
- number