Interface IPivotResults

This interface provides access to the IGroups and AggregateValues accumulated during a pivot grouping process.

Inherited Members
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll

Syntax

public interface IPivotResults : IAggregateResultProvider

Properties

AggregateDescriptions

A read-only collection of the IAggregateDescription used to generate the the available AggregateValues for the GetAggregateResult(Int32, IGroup, IGroup).

Declaration
IReadOnlyList<IAggregateDescription> AggregateDescriptions { get; }
Property Value
IReadOnlyList<IAggregateDescription>

ColumnGroupDescriptions

A read-only collection of the GroupDescriptions used to generate the Root's ColumnGroup IGroups tree.

Declaration
IReadOnlyList<GroupDescription> ColumnGroupDescriptions { get; }
Property Value
IReadOnlyList<GroupDescription>

FilterDescriptions

A read-only collection of the FilterDescription used to filter the items.

Declaration
IReadOnlyList<FilterDescription> FilterDescriptions { get; }
Property Value
IReadOnlyList<FilterDescription>

RowGroupDescriptions

A read-only collection of the GroupDescriptions used to generate the Root's RowGroup IGroups tree.

Declaration
IReadOnlyList<GroupDescription> RowGroupDescriptions { get; }
Property Value
IReadOnlyList<GroupDescription>

Methods

GetAggregateResult(Int32, IGroup, IGroup)

Gets the AggregateValue for the AggregateDescriptionBase at index aggregateIndex for the row and column IGroups.

Declaration
AggregateValue GetAggregateResult(int aggregateIndex, IGroup row, IGroup column)
Parameters
System.Int32 aggregateIndex

The index of the AggregateDescriptionBase for which a value is retrieved.
IGroup row

An IGroup from the Root's RowGroup tree.
IGroup column

An IGroup from the Root's ColumnGroup tree.
Returns
AggregateValue

Null or AggregateValue if it is available.

GetUniqueFilterItems(Int32)

Returns the unique items generated for FilterDescription located at index filterIndex.

Declaration
IEnumerable<object> GetUniqueFilterItems(int filterIndex)
Parameters
System.Int32 filterIndex

The FilterDescription index.
Returns
System.Collections.Generic.IEnumerable<System.Object>

The unique items.

GetUniqueKeys(PivotAxis, Int32)

Returns the unique keys generated for the GroupDescription located at at index .

Declaration
IEnumerable<object> GetUniqueKeys(PivotAxis axis, int index)
Parameters
PivotAxis axis

The axis.
System.Int32 index

The GroupDescription index.
Returns
System.Collections.Generic.IEnumerable<System.Object>

The unique keys.

Extension Methods