Interface IDataProvider

Provides data access for pivot grouping.

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

Syntax

public interface IDataProvider : INotifyPropertyChanged, ISupportInitialize

Properties

AggregatesLevel

Gets or sets the position where groups for the aggregates should be placed.

Declaration
int AggregatesLevel { get; set; }
Property Value
System.Int32

AggregatesPosition

Gets or sets a value indicating where the aggregate groups should be positioned.

Declaration
PivotAxis AggregatesPosition { get; set; }
Property Value
PivotAxis

DeferUpdates

Gets or sets a property that indicates if changes to the grouping settings would trigger computations immediately when invalidated or on explicit Refresh().

Declaration
bool DeferUpdates { get; set; }
Property Value
System.Boolean

FieldInfos

Gets the IFieldInfoData instance that provided information for all available properties of the data source.

Declaration
IFieldInfoData FieldInfos { get; }
Property Value
IFieldInfoData

The field information.

HasPendingChanges

Gets a value that indicates if there are pending changes since the last Refresh(). The value will be true after a change is applied. The value will be false after an automatic or user triggered Refresh(). The value will be false during any work or download process so even if false Results may not be ready yet. In that case you may check Status for additional information.

Declaration
bool HasPendingChanges { get; }
Property Value
System.Boolean

Results

Gets the results from the last grouping.

Declaration
IPivotResults Results { get; }
Property Value
IPivotResults

Settings

Gets or sets the IPivotSettings instance that is being used.

Declaration
IPivotSettings Settings { get; }
Property Value
IPivotSettings

State

Gets the state object that is provided to GetDescriptionsDataAsync(Object) method.

Declaration
object State { get; }
Property Value
System.Object

The object that will be passed to GetDescriptionsDataAsync(Object) method.

Status

Gets the status of this instance.

Declaration
DataProviderStatus Status { get; }
Property Value
DataProviderStatus

Methods

BlockUntilRefreshCompletes()

Block the calling thread until all calculations performed by calling Refresh() method completes.

Declaration
void BlockUntilRefreshCompletes()

DeferRefresh()

Enters a defer cycle that you can use to merge changes to the data provider and delay automatic refresh.

Declaration
IDisposable DeferRefresh()
Returns
System.IDisposable

An IDisposable object that you can use to dispose of the calling object.

GetAggregateDescriptionForFieldDescription(IPivotFieldInfo)

Creates and returns an aggregate description suitable for the supplied field description.

Declaration
IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
IAggregateDescription

An IAggregateDescription instance.

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

Returns a list of suitable functions for the supplied aggregate description.

Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
Returns
System.Collections.Generic.IEnumerable<System.Object>

A list of possible aggregate functions.

GetFilterDescriptionForFieldDescription(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

Declaration
FilterDescription GetFilterDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
FilterDescription

An FilterDescription instance.

GetGroupDescriptionForFieldDescription(IPivotFieldInfo)

Creates and returns a group description suitable for the supplied field description.

Declaration
IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters
IPivotFieldInfo info

A IPivotFieldInfo instance.
Returns
IGroupDescription

An IGroupDescription instance.

Refresh()

Force recalculation operation.

Declaration
void Refresh()

SetAggregateFunctionToAggregateDescription(IAggregateDescription, Object)

Set the aggregateFunction retrieved from GetAggregateFunctionsForAggregateDescription(IAggregateDescription) to the aggregateDescription.

Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
System.Object aggregateFunction

The aggregate function.

Events

PrepareDescriptionForField

Occurs when description should be prepared for a specified field info.

Declaration
event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForField
Event Type
System.EventHandler<PrepareDescriptionForFieldEventArgs>

StatusChanged

Occurs when the current operation has completed.

Declaration
event EventHandler<DataProviderStatusChangedEventArgs> StatusChanged
Event Type
System.EventHandler<DataProviderStatusChangedEventArgs>

Extension Methods