Interface

IDataProvider

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

Declaration

int AggregatesLevel { get; set; }

Property Value

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

Declaration

PivotAxis AggregatesPosition { get; set; }

Property Value

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

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

Declaration

IFieldInfoData FieldInfos { get; }

Property Value

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

Gets the results from the last grouping.

Declaration

IPivotResults Results { get; }

Property Value

Gets or sets the IPivotSettings instance that is being used.

Declaration

IPivotSettings Settings { get; }

Property Value

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

Declaration

object State { get; }

Property Value

Gets the status of this instance.

Declaration

DataProviderStatus Status { get; }

Property Value

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

Declaration

void BlockUntilRefreshCompletes()

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

Declaration

IDisposable DeferRefresh()

Returns

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

Declaration

IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)

Parameters

Returns

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

Returns

Returns a filter description suitable for the supplied field description.

Declaration

FilterDescription GetFilterDescriptionForFieldDescription(IPivotFieldInfo info)

Parameters

Returns

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

Declaration

IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)

Parameters

Returns

Force recalculation operation.

Declaration

void Refresh()

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

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

Declaration

event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForField

Event Value

Occurs when the current operation has completed.

Declaration

event EventHandler<DataProviderStatusChangedEventArgs> StatusChanged

Event Value