New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

IPivotResults

Interface

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

Definition

Namespace:Telerik.Web.UI.PivotGrid.Core

Assembly:Telerik.Web.UI.dll

Syntax:

public interface IPivotResults : IAggregateResultProvider

Inherited Members IAggregateResultProvider.GetAggregateResult(int, Coordinate)IAggregateResultProvider.Root

Properties

AggregateDescriptions

IReadOnlyList<IAggregateDescription>

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

IReadOnlyList<IAggregateDescription> AggregateDescriptions { get; }

ColumnGroupDescriptions

IReadOnlyList<GroupDescription>

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

IReadOnlyList<GroupDescription> ColumnGroupDescriptions { get; }

FilterDescriptions

IReadOnlyList<FilterDescription>

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

IReadOnlyList<FilterDescription> FilterDescriptions { get; }

RowGroupDescriptions

IReadOnlyList<GroupDescription>

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

IReadOnlyList<GroupDescription> RowGroupDescriptions { get; }

Methods

GetAggregateResult(int, IGroup, IGroup)

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

AggregateValue GetAggregateResult(int aggregateIndex, IGroup row, IGroup column)

Parameters:aggregateIndexint

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

rowIGroup

An IGroup from the Root's RowGroup tree.

columnIGroup

An IGroup from the Root's ColumnGroup tree.

Returns:

AggregateValue

Null or AggregateValue if it is available.

GetUniqueFilterItems(int)

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

IEnumerable<object> GetUniqueFilterItems(int filterIndex)

Parameters:filterIndexint

The FilterDescription index.

Returns:

IEnumerable<object>

The unique items.

GetUniqueKeys(PivotAxis, int)

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

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

Parameters:axisPivotAxis

The axis.

indexint

The GroupDescription index.

Returns:

IEnumerable<object>

The unique keys.