C1.PivotEngine.C1PivotEngine
C1PivotEngine Class
Class that tabulates data in a DataSource according to lists of seri fields and creates a DataTable exposed by the PivotTable property.
Implements
Namespace: C1.PivotEngine
Assembly: C1.PivotEngine.dll
Syntax
public class C1PivotEngine : IDisposableConstructors
| Name | Description |
|---|---|
| C1PivotEngine() | Initializes a new instance of a C1PivotEngine. |
Properties
| Name | Description |
|---|---|
| ColumnFields | Gets a list of PivotField objects that define the fields shown as columns in the output table. |
| DataSource | Gets or sets the object that contains data to be analyzed. |
| Fields | Gets the list of PivotField objects exposed by the data source. |
| FilterFields | Gets a list of PivotField objects that define the fields used as filters for the output table. |
| FilteredItemCount | Gets the number of elements that are represented in the current view. |
| IsViewDefined | Gets a value that determines whether a PivotEngine view is currently defined. |
| ItemCount | Gets the number of elements that in the data source. |
| PivotDefaultView | Gets the default IBindingList that exposes the data in the PivotTable. |
| PivotTable | Gets the DataTable that contains the output of the PivotEngine analysis. |
| RowFields | Gets a list of PivotField objects that define the fields shown as rows in the output table. |
| ShowKeyColumns | Gets or sets a value that determines whether the PivotEngine output table should include columns containing the row keys. |
| ShowTotalsColumns | Gets or sets a value that determines whether the PivotEngine output table should include columns containing subtotals or grand totals. |
| ShowTotalsRows | Gets or sets a value that determines whether the PivotEngine output table should include rows containing subtotals or grand totals. |
| ShowZeros | Gets or sets a value that determines whether the PivotEngine output table should use zeros to indicate missing values. |
| SortOnServer | Gets or sets a value that indicates whether the summary data received from the server is already sorted. If this property is set to true, the PivotEngine will not sort the data it receives from the server. |
| TotalsBeforeData | Gets or sets a value that determines whether row and column totals should be displayed before or after regular data rows and columns. If this value is set to true, total rows appear above data rows and total columns appear on the left of regular data columns. |
| ValueField | Gets the first PivotField in the ValueFields collection, or null if the collection is empty. |
| ValueFields | Gets a list of PivotField objects that define the fields summarized in the cells of the output table. |
| ViewDefinition | Gets or sets the PivotEngine view definition as an XML string. |
| Workspace | Gets or sets the DataEngine workspace. |
Methods
| Name | Description |
|---|---|
| BeginUpdate() | Suspend automatic updates to the output table while defining the PivotEngine view. |
| CancelUpdate() | Requests cancellation of a pending request operation. |
| ConnectDataEngine(string) | Connect to a C1.DataEngine table. |
| Dispose() | Clean up any resources being used. |
| DisposeWorkspace(string) | Disposes the specified workspace and cancel all related tasks |
| EndUpdate() | Restore automatic updates to the output table after the PivotEngine view has been defined. |
| Exec(IEnumerable, Dictionary<string, object>, CancellationToken, ProgressDelegate) | Server-side asynchronous execution of a view returning aggregated results to the caller client. |
| Exec(string, string, Dictionary<string, object>, CancellationToken, ProgressDelegate) | Server-side asynchronous execution of a view returning aggregated results to the caller client. |
| GetDetail(DataRow, DataColumn) | Gets a list of objects in the raw data source that define the content of a specific cell in the output table exposed by the PivotTable property. |
| GetDetail(DataRow, string) | Gets a list of objects in the raw data source that define the content of a specific cell in the output table exposed by the PivotTable property. |
| GetDetails(IEnumerable, Dictionary<string, object>, object[], CancellationToken) | Makes source data rows used in obtaining a given aggregated value accessible to the server's clients. |
| 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. |
| GetMetadata(IEnumerable, CancellationToken) | Lists fields with their types and provides other metadata for a data source. |
| GetMetadata(string, string, CancellationToken) | Lists fields with their types and provides other metadata for a DataEngine table. |
| GetPivotKey(DataColumn) | Gets the PivotKey associated with a DataColumn on a PivotEngine table. |
| GetPivotKey(DataRow) | Gets the PivotKey associated with a DataRow on a PivotEngine table. |
| GetRawData(IEnumerable, CancellationToken) | Makes the entire raw source data collection accessible to the server's clients. |
| GetRawData(string, string, CancellationToken) | Makes the entire raw source data collection accessible to the server's clients. |
| GetUniqueValues(PivotField, out Exception, int, int) | Gets a list of unique values from a PivotField. |
| GetUniqueValues(IEnumerable, Dictionary<string, object>, string, CancellationToken) | Lists unique values of a field for the server's clients. |
| GetUniqueValues(string, string, Dictionary<string, object>, string, CancellationToken) | Lists unique values of a field for the server's clients. |
| GetViewTitle() | Gets a string with a title describing the current view. |
| GetViewTitle(string, string) | Gets a localized string with a title describing the current view. |
| OnCancelUpdating(EventArgs) | |
| OnDataEngineWorkspaceChanged(WorkspaceEventArgs) | |
| OnLoadedFields(EventArgs) | Raises the LoadedFields event. |
| OnStartUpdating(EventArgs) | |
| OnUpdateError(ErrorEventArgs) | Raises the UpdateError event. |
| OnUpdated(EventArgs) | Raises the Updated event. |
| OnUpdating(EventArgs) | Raises the Updating event. |
| ReadXml(string) | Reads a PivotEngine view definition from a file. |
| ReadXml(XmlReader) | Reads a PivotEngine view definition from an System.Xml.XmlReader. |
| TransposeFields() | Transposes the fields in the current view so rows become columns and columns become rows. |
| Update() | Causes the C1.PivotEngine.PivotEngine to rebuild the output table exposed by the PivotTable property. |
| WriteXml(string) | Saves the current PivotEngine view definition into an XML file. |
| WriteXml(XmlWriter) | Saves the current PivotEngine view definition into an System.Xml.XmlWriter. |
Events
| Name | Description |
|---|---|
| CancelUpdating | Occurs when calculation is cancelled. |
| LoadedFields | Fires after the C1.PivotEngine.PivotEngine finishes loading the fields for the current DataSource. |
| StartUpdating | Occurs when calculation starts. |
| UpdateCompleted | Fires after the update of the C1PivotEngine is finished. |
| UpdateError | Fires when an error occurs while updating. |
| UpdateProgressChanged | Fires when the update progress of the C1PivotEngine is changed. |
| Updated | Fires after the C1.PivotEngine.PivotEngine finishes its analysis and the output PivotTable is ready. |
| Updating | Fires before the C1.PivotEngine.PivotEngine starts updating the output PivotTable. |
Operators
| Name | Description |
|---|---|
| implicit operator C1FlexPivotEngine(C1PivotEngine) |