Usage
Signature:
class MutableArrayTreeDataProvider<K, D> implements TreeDataProvider<K, D>
Generic Parameters
Parameter Description K Type of Key D Type of Data
Typescript Import Format
//To import this class, use the format below.
import {MutableArrayTreeDataProvider} from "ojs/ojmutablearraytreedataprovider";
For additional information visit:
Constructor
new MutableArrayTreeDataProvider(data, keyAttribute, options)
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
data |
any | Applications shouldn't call array mutation methods such as splice or push on "data" directly. Applications need to use ojimmutabletreedatautils or immutable libs like immutablejs to update the array, and set it back into the "data" property. | |
keyAttribute |
string | '@value' | The field name which stores the key in the data. Can be a string denoting a single key attribute. Please note that the ids in MutableArrayTreeDataProvider must always be unique. Please do not introduce duplicate ids, even during temporary mutation operations.@value will cause MutableArrayTreeDataProvider to use all attributes as key. | |
options |
MutableArrayTreeDataProvider.Options.<D> |
<optional> |
Options for the MutableArrayTreeDataProvider |
Example
import { MutableArrayTreeDataProvider } from "ojs/ojmutablearraytreedataprovider";
// First initialize the tree data. This can be defined locally or read from file.
const treeData = [
{"attr": {"id": "dir1", "title": "Directory 1"},
"children": [
{"attr": {"id": "subdir1", "title": "Subdirectory 1"},
"children": [
{"attr": {"id": "file1", "title": "File 1"}},
{"attr": {"id": "file2", "title": "File 2"}},
{"attr": {"id": "file3", "title": "File 3"}}
]},
{"attr": {"id": "subdir2", "title": "Subdirectory 2"},
"children": []}
]},
{"attr": {"id": "dir2", "title": "Directory 2"},
"children": [
{"attr": {"id": "file4", "title": "File 4"}},
{"attr": {"id": "file5", "title": "File 5"}},
]}
];
// Then create an MutableArrayTreeDataProvider object with the array
create an immutable array treeDataImmutable
const dp = new MutableArrayTreeDataProvider(treeDataImmutable, 'attr.id');Fields
-
data
-
The underlying data array.
Applications can get this property directly only can set it on the root data provider, such as setting it to a different array.
Applications should not call array mutation methods such as splice or push on "data" directly. Applications need to create a new immutable array by ojimmutabletreedatautils or immutable libs and set it back into the "data" property.
- Since:
- 13.0.0
Properties:
Name Type dataany Examples
Example of mutating the entire tree
const rootTreeDataProvider = new MutableArrayTreeDataProvider(rootData, 'id'); let newRootData; Initialize newRootData to a new immutable array newRootDataImmutable rootTreeDataProvider.data = newRootDataImmutable;Example of mutating the data in a branch
create an immutable array immutableData const rootTreeDataProvider = new MutableArrayTreeDataProvider(immutableData, 'id'); update immutableData // set it back to rootTreeDataProvider.data rootTreeDataProvider.data = immutableData;
Methods
-
addEventListener(eventType: string, listener: EventListener): void
-
Add a callback function to listen for a specific event type.
Parameters:
Name Type Description eventTypestring The event type to listen for. listenerEventListener The callback function that receives the event notification. -
containsKeys(parameters : FetchByKeysParameters<K>) : Promise<ContainsKeysResults<K>>
-
Check if there are rows containing the specified keys. If this method is called on a DataProvider returned from
getChildDataProvider(key), the rows will be only those from the children of thekey.Parameters:
Name Type Description parametersFetchByKeysParameters contains by key parameters - Since:
- 4.2.0
Returns:
Returns Promise which resolves to ContainsKeysResults.
- Type
- Promise.<ContainsKeysResults>
Example
Check if keys 1001 and 556 are contained
let containsKeys = [1001, 556]; let value = await dataprovider.containsKeys({keys: containsKeys}); let results = value['results']; if (results.has(1001)) { console.log('Has key 1001'); } else if (results.has(556){ console.log('Has key 556'); } -
createOptimizedKeyMap(initialMap?: Map<K, D>): Map<K, D>
-
Return an empty Map which is optimized to store key value pairs
Optionally provided by certain DataProvider implementations for storing key/value pairs from the DataProvider in a performant fashion. Sometimes components will need to temporarily store a Map of keys provided by the DataProvider, for example, in the case of maintaining a Map of selected keys. Only the DataProvider is aware of the internal structure of keys such as whether they are primitives, Strings, or objects and how to do identity comparisons. Therefore, the DataProvider can optionally provide a Map implementation which can performantly store key/value pairs surfaced by the DataProvider.
Parameters:
Name Type Argument Description initialMapMap.<any> <optional>
Optionally specify an initial map of key/values for the Map. If not specified, then return an empty Map. - Since:
- 6.2.0
Returns:
Returns a Map optimized for handling keys from the DataProvider.
- Type
- Map.<any>
Example
create empty key Map
let keyMap = dataprovider.createOptimizedKeyMap(); -
createOptimizedKeySet(initialSet?: Set<K>): Set<K>
-
Return an empty Set which is optimized to store keys
Optionally provided by certain DataProvider implementations for storing keys from the DataProvider in a performant fashion. Sometimes components will need to temporarily store a Set of keys provided by the DataProvider, for example, in the case of maintaining a Set of selected keys. Only the DataProvider is aware of the internal structure of keys such as whether they are primitives, Strings, or objects and how to do identity comparisons. Therefore, the DataProvider can optionally provide a Set implementation which can performantly store keys surfaced by the DataProvider.
Parameters:
Name Type Argument Description initialSetSet.<any> <optional>
Optionally specify an initial set of keys for the Set. If not specified, then return an empty Set. - Since:
- 6.2.0
Returns:
Returns a Set optimized for handling keys from the DataProvider.
- Type
- Set.<any>
Example
create empty key Set
let keySet = dataprovider.createOptimizedKeySet(); -
dispatchEvent(evt: Event): boolean
-
Dispatch an event and invoke any registered listeners.
Parameters:
Name Type Description eventEvent The event object to dispatch. Returns:
Return false if a registered listener has cancelled the event. Return true otherwise.
- Type
- boolean
-
fetchByKeys(parameters : FetchByKeysParameters<K>) : Promise<FetchByKeysResults<K, D>>
-
Fetch rows by keys. If this method is called on a DataProvider returned from
getChildDataProvider(key), the rows will be only those from the children of thekey.Parameters:
Name Type Description parametersFetchByKeysParameters fetch by key parameters - Since:
- 4.2.0
Returns:
Returns Promise which resolves to FetchByKeysResults.
- Type
- Promise.<FetchByKeysResults>
Example
Fetch for keys 1001 and 556
let fetchKeys = [1001, 556]; let value = await dataprovider.fetchByKeys({keys: fetchKeys}); // get the data for key 1001 console.log(value.results.get(1001).data); -
fetchByOffset(parameters: FetchByOffsetParameters<D>): Promise<FetchByOffsetResults<K, D>>
-
Fetch rows by offset
A generic implementation of this method is available from FetchByOffsetMixin. It is for convenience and may not provide the most efficient implementation for your data provider. Classes that implement the DataProvider interface are encouraged to provide a more efficient implementation.
Parameters:
Name Type Description parametersFetchByOffsetParameters fetch by offset parameters - Since:
- 4.2.0
Returns:
Returns Promise which resolves to FetchByOffsetResults.
- Type
- Promise.<FetchByOffsetResults>
Example
Fetch by offset 5 rows starting at index 2
let result = await dataprovider.fetchByOffset({size: 5, offset: 2}); let results = result['results']; let data = results.map(function(value) { return value['data']; }); let keys = results.map(function(value) { return value['metadata']['key']; }); -
fetchFirst(parameters?: FetchListParameters<D>): AsyncIterable<FetchListResult<K, D>>
-
Get an AsyncIterable object for iterating the data.
AsyncIterable contains a Symbol.asyncIterator method that returns an AsyncIterator. AsyncIterator contains a “next” method for fetching the next block of data.
The "next" method returns a promise that resolves to an object, which contains a "value" property for the data and a "done" property that is set to true when there is no more data to be fetched. The "done" property should be set to true only if there is no "value" in the result. Note that "done" only reflects whether the iterator is done at the time "next" is called. Future calls to "next" may or may not return more rows for a mutable data source.
In order for JET components to work correctly, DataProvider implementations should ensure that:
- The iterator accounts for data mutations when returning the next block of data, and that no row is duplicated or skipped. For example, an offset-based implementation may need to adjust the offset from which the next block of data starts if rows have been added or removed in the returned data.
- JET components may call "next" on the iterator even after the iterator has returned done:true. If new data is available after the last returned row, the iterator is expected to return the new data and set "done" to false. This differs from the AsyncIterator spec for performance reasons.
Please see the DataProvider documentation for more information on custom implementations.
Parameters:
Name Type Argument Description paramsFetchListParameters <optional>
fetch parameters - Since:
- 4.2.0
- See:
-
- https://github.com/tc39/proposal-async-iteration for further information on AsyncIterable.
Returns:
AsyncIterable with FetchListResult
- Type
- AsyncIterable.<FetchListResult>
Example
Get an asyncIterator and then fetch first block of data by executing next() on the iterator. Subsequent blocks can be fetched by executing next() again.
let asyncIterator = dataprovider.fetchFirst(options)[Symbol.asyncIterator](); let result = await asyncIterator.next(); let value = result.value; let data = value.data; let keys = value.metadata.map(function(val) { return val.key; }); -
getCapability(capabilityName: string): any
-
Determines whether this DataProvider defines a certain feature.
Parameters:
Name Type Description capabilityNamestring capability name. Defined capability names are: "fetchByKeys", "fetchByOffset", "sort", "fetchCapability" and "filter". - Since:
- 4.2.0
Returns:
capability information or null if undefined
- If capabilityName is "fetchByKeys", returns a FetchByKeysCapability object.
- If capabilityName is "fetchByOffset", returns a FetchByOffsetCapability object.
- If capabilityName is "sort", returns a SortCapability object.
- If capabilityName is "filter", returns a FilterCapability object.
- If capabilityName is "fetchCapability", returns a FetchCapability object.
- Type
- Object
Example
Check what kind of fetchByKeys is defined.
let capabilityInfo = dataprovider.getCapability('fetchByKeys'); if (capabilityInfo.implementation == 'iteration') { // the DataProvider supports iteration for fetchByKeys ... -
getChildDataProvider(parentKey: K): MutableArrayTreeDataProvider<K, D> | null
-
- Since:
- 13.0.0
Returns:
A TreeDataProvider if the row can (but doesn't have to) have children; or null if the row cannot have children. Use the
isEmptymethod on the returned TreeDataProvider to determine if it currently has children.- Type
- MutableArrayTreeDataProvider | null
Example
Example for getChildDataProvider
// Get child data provider for node 10 let childDataProvider = dataprovider.getChildDataProvider(10); -
getTotalSize : {Promise.<number>}
-
Return the total number of rows in this dataprovider
Returns:
Returns a Promise which resolves to the total number of rows. -1 is unknown row count.
- Type
- Promise.<number>
Example
Get the total rows
let value = await dataprovider.getTotalSize(); if (value == -1) { // we don't know the total row count } else { // the total count console.log(value); } -
isEmpty(): 'yes' | 'no' | 'unknown'
-
Returns a string that indicates if this data provider is empty. Valid values are:
- "yes": this data provider is empty.
- "no": this data provider is not empty.
- "unknown": it is not known if this data provider is empty until a fetch is made.
- Since:
- 4.2.0
Returns:
string that indicates if this data provider is empty
- Type
- "yes" | "no" | "unknown"
Example
Check if empty
let isEmpty = dataprovider.isEmpty(); console.log('DataProvider is empty: ' + isEmpty); -
removeEventListener(eventType: string, listener: EventListener): void
-
Remove a listener previously registered with addEventListener.
Parameters:
Name Type Description eventTypestring The event type that the listener was registered for. listenerEventListener The callback function that was registered.
Type Definitions
-
Options<D>
-
- 'global': the key values are unique within the entire tree.
- 'siblings': the key values are unique among the siblings of each node.
Properties:
Name Type Argument Description childrenAttributestring <optional>
Optional field name which stores the children of nodes in the data. Dot notation can be used to specify nested attribute. If this is not specified, the default is "children". implicitSortArray.<SortCriterion.<D>> <optional>
Optional array of SortCriterion used to specify sort information when the data loaded into the dataprovider is already sorted. This is used for cases where we would like display some indication that the data is already sorted. For example, ojTable will display the column sort indicator for the corresponding column in either ascending or descending order upon initial render. This option is not used for cases where we want the MutableArrayTreeDataProvider to apply a sort on initial fetch. For those cases, please wrap in a ListDataProviderView and set the sortCriteria property on it. keyAttributeScope'siblings' | 'global' <optional>
Optional scope of the key values in the fields specified by keyAttribute. Supported values:
sortComparatorsArrayDataProvider.SortComparators<D> <optional>
Optional sortComparator to use for sort. Sort follows JavaScript's localeCompare
{numeric: true}. Please check String.prototype.localeCompare() for details.For numbers, we convert them into strings then compare them with localeCompare, which may not sort floating point numbers based on their numeric values. If you want to sort floating point numbers based on their numeric values, sortComparator can be used to do a custom sort.
For undefined and null values, they are considered as the largest values during sorting. For an empty string, it is considered as the smallest value during sorting.
textFilterAttributesstring[] <optional>
Optionally specify which attributes the filter should be applied on when a TextFilter filterCriteria is specified. If this option is not specified then the filter will be applied to all attributes.