GetHyperCubeTreeDataAsync Method
Overloads
| GetHyperCubeTreeDataAsync(String, NxTreeDataOption) |
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data. |
|
| GetHyperCubeTreeDataAsync(AsyncHandle, String, NxTreeDataOption) |
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data. |
|
| GetHyperCubeTreeDataAsync<T>(AsyncHandle, Func<Response, T>, String, NxTreeDataOption) |
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data. |
GetHyperCubeTreeDataAsync(String, NxTreeDataOption)
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
Declaration
Task<IEnumerable<NxTreeNode>> GetHyperCubeTreeDataAsync([QixName("qPath")] string path, [QixName("qNodeOptions")] NxTreeDataOption nodeOptions = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | path |
Path to the definition of the object to be selected. |
| NxTreeDataOption | nodeOptions |
Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxTreeNode>> |
Remarks
This method works for a treedata object or a hypercube in DATA_MODE_TREE.
GetHyperCubeTreeDataAsync(AsyncHandle, String, NxTreeDataOption)
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
Declaration
Task<IEnumerable<NxTreeNode>> GetHyperCubeTreeDataAsync(AsyncHandle asyncHandle, [QixName("qPath")] string path, [QixName("qNodeOptions")] NxTreeDataOption nodeOptions = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | path |
Path to the definition of the object to be selected. |
| NxTreeDataOption | nodeOptions |
Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<NxTreeNode>> |
Remarks
This method works for a treedata object or a hypercube in DATA_MODE_TREE.
GetHyperCubeTreeDataAsync<T>(AsyncHandle, Func<Response, T>, String, NxTreeDataOption)
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
Declaration
Task<T> GetHyperCubeTreeDataAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qPath")] string path, [QixName("qNodeOptions")] NxTreeDataOption nodeOptions = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | path |
Path to the definition of the object to be selected. |
| NxTreeDataOption | nodeOptions |
Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |
Remarks
This method works for a treedata object or a hypercube in DATA_MODE_TREE.
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!