C1.PivotEngine.C1PivotEngine.GetDetails

GetDetails Method

GetDetails(string, string, Dictionary<string, object>, object[], CancellationToken)

Makes source data rows used in obtaining a given aggregated value accessible to the server's clients.

Declaration

public static Task<IList> GetDetails(string workspace, string table, Dictionary<string, object> view, object[] key, CancellationToken cancelToken)

Public Shared Function GetDetails(workspace As String, table As String, view As Dictionary(Of String, Object), key As Object(), cancelToken As CancellationToken) As Task(Of IList)

Parameters

Type	Name	Description
string	workspace	Path in the server's file system where DataEngine data is saved in files.
string	table	The name of a DataEngine table.
Dictionary<string, object>	view	View definition used for performing aggregation.
object[]	key	Key values specifying the aggregated value (subtotal). See a description of keys and values in C1.PivotEngine.C1PivotEngine.Exec(string, string, System.Collections.Generic.Dictionary<string,object>, System.Threading.CancellationToken)
CancellationToken	cancelToken	Enables task cancellation.

Returns

Type	Description
Task<IList>	List of source data objects that contributed to the given aggregation value.

Remarks

It is recommended to use paging providing source data to the clients, because a DataEngine table can have a very large number of rows and aggregating a subtotal can involve a considerable part of all rows.

GetDetails(IEnumerable, Dictionary<string, object>, object[], CancellationToken)

Makes source data rows used in obtaining a given aggregated value accessible to the server's clients.

Declaration

public static Task<IList> GetDetails(IEnumerable dataSource, Dictionary<string, object> view, object[] key, CancellationToken cancelToken)

Public Shared Function GetDetails(dataSource As IEnumerable, view As Dictionary(Of String, Object), key As Object(), cancelToken As CancellationToken) As Task(Of IList)

Parameters

Type	Name	Description
IEnumerable	dataSource	Data source collection.
Dictionary<string, object>	view	View definition used for performing aggregation.
object[]	key	Key values specifying one aggregated value (subtotal). See a description of keys and values in C1.PivotEngine.C1PivotEngine.Exec(string, string, System.Collections.Generic.Dictionary<string,object>, System.Threading.CancellationToken)
CancellationToken	cancelToken	Enables task cancellation.

Returns

Type	Description
Task<IList>	List of source data objects that contributed to the given aggregation value.