Back to all docs
API Reference / Telerik.Pivot.Core.Filtering / SortedGroupsFilter

Class
SortedGroupsFilter

A base class for groups filter based on sorted list.

Definition

Namespace:Telerik.Pivot.Core.Filtering

Assembly:Telerik.Pivot.Core.dll

Syntax:
cs-api-definition
[DataContract]
public abstract class SortedGroupsFilter : SiblingGroupsFilter, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IEditable

Inheritance: objectCloneableSettingsNodeGroupFilterSiblingGroupsFilterSortedGroupsFilter

Derived Classes: GroupsCountFilterGroupsPercentFilterGroupsSumFilter

Implements: IEditableINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members SettingsNode.NotifyServicesChanged()SettingsNode.NotifySettingsChanged(SettingsChangedEventArgs)SettingsNode.OnSettingsChanged(SettingsChangedEventArgs)SettingsNode.BeginEdit()SettingsNode.BeginInit()SettingsNode.EndInit()SettingsNode.GetService(Type)SettingsNode.OnPropertyChanged(string)SettingsNode.RemoveSettingsChild(SettingsNode)SettingsNode.AddSettingsChild(SettingsNode)SettingsNode.GetServiceOverride(Type)SettingsNode.OnEnteredEditScope()SettingsNode.OnExitingEditScope()SettingsNode.ParentSettingsNode.SettingsChangedSettingsNode.ServicesChangedSettingsNode.PropertyChangedCloneable.Clone()Cloneable.CreateInstanceCore()

Constructors

SortedGroupsFilter()

Declaration

cs-api-definition
protected SortedGroupsFilter()

Properties

AggregateIndex

Specifies which aggregate description in the grouping would be used as source for comparison.

Declaration

cs-api-definition
[DataMember]
public int AggregateIndex { get; set; }

Property Value

int

Comparer

Gets or sets the comparer used to sort for the Selection.

Declaration

cs-api-definition
[DataMember]
public IComparer<AggregateValue> Comparer { get; set; }

Property Value

IComparer<AggregateValue>

Selection

Specifies whether the Top or Bottom groups would be accepted by the filter.

Declaration

cs-api-definition
[DataMember]
public SortedListSelection Selection { get; set; }

Property Value

SortedListSelection

Methods

CloneCore(Cloneable)

Makes the instance a clone (deep copy) of the specified Cloneable.

Declaration

cs-api-definition
protected override void CloneCore(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Overrides Cloneable.CloneCore(Cloneable)

Remarks

Notes to Inheritors If you derive from Cloneable, you may need to override this method to copy all properties. It is essential that all implementations call the base implementation of this method (if you don't call base you should manually copy all needed properties including base properties).

Filter(IReadOnlyList<IGroup>, IAggregateResultProvider, PivotAxis, int)

Filters the groups within a parent group. Can filter based on count, average values or sorted values.

Declaration

cs-api-definition
protected override sealed ICollection<IGroup> Filter(IReadOnlyList<IGroup> groups, IAggregateResultProvider results, PivotAxis axis, int level)

Parameters

groups

IReadOnlyList<IGroup>

A read only list of all siblings.

results

IAggregateResultProvider

The current aggregate results.

axis

PivotAxis

Identifies if the groups are in Rows or Columns.

level

int

The level of the groups.

Returns

ICollection<IGroup>

A ICollection<T> implementation that is used to filter the groups.

Overrides SiblingGroupsFilter.Filter(IReadOnlyList<IGroup>, IAggregateResultProvider, PivotAxis, int)

In this article
DefinitionConstructorsSortedGroupsFilter()PropertiesAggregateIndexComparerSelectionMethodsCloneCore(Cloneable)Filter(IReadOnlyList<IGroup>, IAggregateResultProvider, PivotAxis, int)
Not finding the help you need?
Contact Support