Class PivotEngine<TValue>

PivotEngine class is used to manipulate the relational or Multi-Dimensional data as pivoting values to render the pivot table.

Inheritance

System.Object

PivotEngine<TValue>

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.EJ2.Pivot

Assembly: Syncfusion.EJ2.Pivot.dll

Syntax

public class PivotEngine<TValue>

Type Parameters

Name	Description
TValue	A type which provides schema for the pivot component.

Constructors

PivotEngine()

Declaration

public PivotEngine()

Methods

GetEngine(FetchData)

Generates an Syncfusion.EJ2.Pivot.EngineProperties object containing information such as headers, pivot values, field list, paging, and more required for rendering the Pivot Table.

Declaration

public Task<EngineProperties> GetEngine(FetchData param)

Parameters

Type	Name	Description
Syncfusion.EJ2.Pivot.FetchData	param	The input parameters used to generate the engine properties.

Returns

Type	Description
System.Threading.Tasks.Task<Syncfusion.EJ2.Pivot.EngineProperties>	An Syncfusion.EJ2.Pivot.EngineProperties object containing the engine properties.

GetRawData(FetchData, EngineProperties)

Retrieves raw data from an Syncfusion.EJ2.Pivot.EngineProperties object based on the specified param.

Declaration

public Dictionary<string, object> GetRawData(FetchData param, EngineProperties engine)

Parameters

Type	Name	Description
Syncfusion.EJ2.Pivot.FetchData	param	The Syncfusion.EJ2.Pivot.FetchData object containing information about the data to retrieve.
Syncfusion.EJ2.Pivot.EngineProperties	engine	The Syncfusion.EJ2.Pivot.EngineProperties object containing the raw data.

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A dictionary containing the raw data and index object of selected value cell.

Remarks

The raw data is retrieved from the engine object based on the row and column index specified in the param object.

If data compression is allowed (as specified in the param object), the method retrieves uncompressed data and its corresponding indices from the engine object. Otherwise, it retrieves the casted data from the engine object.

GetSerializedPivotValues()

Returns a JSON representation of the pivot values for rendering the EJ2 Pivot Table.

Declaration

public Dictionary<string, object> GetSerializedPivotValues()

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A System.Collections.Generic.Dictionary<, > containing the following key-value pairs: "pivotValue": A string representation of the pivot values "fieldList": A string representation of the field list "pivotCount": A string representation of the scroll page information "dataSourceSettings": A string representation of the data source settings "fields": A string representation of the fields

PerformAction(EngineProperties, FetchData)

Performs the specified action on the engine with the given parameters and returns a new instance of EngineProperties containing information required for updating the Pivot Table.

Declaration

public Task<EngineProperties> PerformAction(EngineProperties engine, FetchData param)

Parameters

Type	Name	Description
Syncfusion.EJ2.Pivot.EngineProperties	engine	The current instance of EngineProperties.
Syncfusion.EJ2.Pivot.FetchData	param	The parameters for the action.

Returns

Type	Description
System.Threading.Tasks.Task<Syncfusion.EJ2.Pivot.EngineProperties>	A new instance of EngineProperties with updated information for the Pivot Table.