C1.PivotEngine.PivotKey
PivotKey Class
Represents a combination of PivotField objects and their values.
Implements
Namespace: C1.PivotEngine
Assembly: C1.PivotEngine.dll
Syntax
public class PivotKey : IComparableRemarks
Each row and column on the output FlexPivot table is defined by a unique PivotKey. The values in the table cells represent an aggregation of the value field for all items that match the row and column keys.
For example, if a column key is set to 'Country:UK;Customer:Joe' and the row key is set to 'Category:Desserts;Product:Pie', then the corresponding cell contains the aggregate for all items with the following properties: 'Country:UK;Customer:Joe;Category:Desserts;Product:Pie'.
Properties
| Name | Description |
|---|---|
| Fields | Gets the list of PivotField pivot fields associated with this PivotKey. |
| ValueField | Gets the PivotField that represents the value field associated with this PivotKey. |
| Values | Gets an array of values for the PivotField pivot fields associated with this PivotKey. |
Methods
| Name | Description |
|---|---|
| Equals(object) | Returns true if two PivotKey objects represent the same set of PivotField objects and values. |
| GetFormattedValue(int) | Gets a formatted value from the Values array. |
| GetFormattedValue(int, object) | Gets a formatted value from the Values array. |
| GetHashCode() | Serves as a hash function for a PivotKey object. |
| MatchesItem(object) | Gets a value that determines whether a given data object matches the content of this PivotKey. |
| MatchesKey(PivotKey) | Gets a value that indicates whether this PivotKey partially matches the content of another key. |
| ToString() | Returns a string that represents this PivotKey. |