Interface DataSource

AddOnSchemaChangedListener Represents a data source for use in components which need advanced access to data.

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public interface DataSource

Properties

DeferAutoRefresh

Declaration

bool DeferAutoRefresh { get; set; }

Property Value

Type	Description
System.Boolean

FilterExpressions

Declaration

IgbFilterExpressionCollection FilterExpressions { get; }

Property Value

Type	Description
IgbFilterExpressionCollection

FirstVisibleIndexRequested

Declaration

int FirstVisibleIndexRequested { get; set; }

Property Value

Type	Description
System.Int32

IncludeSummaryRowsInSection

Declaration

bool IncludeSummaryRowsInSection { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionCollapsable

Declaration

bool IsSectionCollapsable { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionContentVisible

Declaration

bool IsSectionContentVisible { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionExpandedDefault

Declaration

bool IsSectionExpandedDefault { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionHeaderNormalRow

Declaration

bool IsSectionHeaderNormalRow { get; set; }

Property Value

Type	Description
System.Boolean

IsSectionSummaryRowsAtBottom

Declaration

bool IsSectionSummaryRowsAtBottom { get; set; }

Property Value

Type	Description
System.Boolean

LastVisibleIndexRequested

Declaration

int LastVisibleIndexRequested { get; set; }

Property Value

Type	Description
System.Int32

PrimaryKey

Declaration

string[] PrimaryKey { get; set; }

Property Value

Type	Description
System.String[]

PropertiesRequested

Declaration

string[] PropertiesRequested { get; set; }

Property Value

Type	Description
System.String[]

SchemaIncludedProperties

Declaration

string[] SchemaIncludedProperties { get; set; }

Property Value

Type	Description
System.String[]

SectionHeaderDisplayMode

Declaration

DataSourceSectionHeaderDisplayMode SectionHeaderDisplayMode { get; set; }

Property Value

Type	Description
DataSourceSectionHeaderDisplayMode

ShouldEmitSectionFooters

Declaration

bool ShouldEmitSectionFooters { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitSectionHeaders

Declaration

bool ShouldEmitSectionHeaders { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitShiftedRows

Declaration

bool ShouldEmitShiftedRows { get; set; }

Property Value

Type	Description
System.Boolean

ShouldEmitSummaryRows

Declaration

bool ShouldEmitSummaryRows { get; set; }

Property Value

Type	Description
System.Boolean

SummaryScope

Declaration

DataSourceSummaryScope SummaryScope { get; set; }

Property Value

Type	Description
DataSourceSummaryScope

UpdateNotifier

Declaration

DataSourceUpdateNotifier UpdateNotifier { get; set; }

Property Value

Type	Description
DataSourceUpdateNotifier

Methods

ClearPinnedRows()

Declaration

void ClearPinnedRows()

ClearPinnedRowsAsync()

Called to clear all pinned rows.

Declaration

Task ClearPinnedRowsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Clone()

Declaration

DataSource Clone()

Returns

Type	Description
DataSource

CloneAsync()

Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance.

Declaration

Task<DataSource> CloneAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DataSource>

FlushAutoRefresh()

Declaration

void FlushAutoRefresh()

FlushAutoRefreshAsync()

Called to make sure a queued refresh of the data source has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data source. Note, for a virtual data source, the data source itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes

Declaration

Task FlushAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

GetIsRowExpandedAtIndex(Int32)

Declaration

bool GetIsRowExpandedAtIndex(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Boolean

GetIsRowExpandedAtIndexAsync(Int32)

Gets the expansion state for a row.

Declaration

Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

GetItemProperty(Object, String)

Declaration

object GetItemProperty(object item, string propertyName)

Parameters

Type	Name	Description
System.Object	item
System.String	propertyName

Returns

Type	Description
System.Object

GetItemPropertyAsync(Object, String)

Declaration

Task<object> GetItemPropertyAsync(object item, string propertyName)

Parameters

Type	Name	Description
System.Object	item
System.String	propertyName

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetItemPropertyAtIndex(Int32, String)

Declaration

object GetItemPropertyAtIndex(int index, string valueName)

Parameters

Type	Name	Description
System.Int32	index
System.String	valueName

Returns

Type	Description
System.Object

GetItemPropertyAtIndexAsync(Int32, String)

Declaration

Task<object> GetItemPropertyAtIndexAsync(int index, string valueName)

Parameters

Type	Name	Description
System.Int32	index
System.String	valueName

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

GetMainValuePath(DataSourceRowType)

Declaration

string GetMainValuePath(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.String

GetMainValuePathAsync(DataSourceRowType)

Gets the type of row at the specified index.

Declaration

Task<string> GetMainValuePathAsync(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

GetRootSummaryResults()

Declaration

IgbDataGridSummaryResult[] GetRootSummaryResults()

Returns

Type	Description
IgbDataGridSummaryResult[]

GetRootSummaryResultsAsync()

Gets the summary results for the root level.

Declaration

Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[]>

GetRootSummaryRowCount()

Declaration

int GetRootSummaryRowCount()

Returns

Type	Description
System.Int32

GetRootSummaryRowCountAsync()

Gets the number of summary rows at the root level.

Declaration

Task<int> GetRootSummaryRowCountAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetRowLevel(Int32)

Declaration

int GetRowLevel(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Int32

GetRowLevelAsync(Int32)

Gets the hierarchy level of the row.

Declaration

Task<int> GetRowLevelAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex	The row to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

GetRowType(Int32)

Declaration

DataSourceRowType GetRowType(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
DataSourceRowType

GetRowTypeAsync(Int32)

Gets the type of row at the specified index.

Declaration

Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)

Parameters

Type	Name	Description
System.Int32	rowIndex

Returns

Type	Description
System.Threading.Tasks.Task<DataSourceRowType>

GetSectionSummaryResults(Int32)

Declaration

IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)

Parameters

Type	Name	Description
System.Int32	sectionIndex

Returns

Type	Description
IgbDataGridSummaryResult[][]

GetSectionSummaryResultsAsync(Int32)

Gets the summary results for a specific section.

Declaration

Task<IgbDataGridSummaryResult[][]> GetSectionSummaryResultsAsync(int sectionIndex)

Parameters

Type	Name	Description
System.Int32	sectionIndex

Returns

Type	Description
System.Threading.Tasks.Task<IgbDataGridSummaryResult[][]>

GetStickyRowPriority(Int32)

Declaration

int GetStickyRowPriority(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Int32

GetStickyRowPriorityAsync(Int32)

Gets the priority of a pinned row, which defines how it interacts with other pinned rows.

Declaration

Task<int> GetStickyRowPriorityAsync(int row)

Parameters

Type	Name	Description
System.Int32	row	The index of the row to get the priority for.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

IndexOfItem(Object)

Declaration

int IndexOfItem(object item)

Parameters

Type	Name	Description
System.Object	item

Returns

Type	Description
System.Int32

IndexOfItemAsync(Object)

Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported.

Declaration

Task<int> IndexOfItemAsync(object item)

Parameters

Type	Name	Description
System.Object	item	The item for which to find the index.

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

IndexOfKey(Object[])

Declaration

int IndexOfKey(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Int32

IndexOfKeyAsync(Object[])

Declaration

Task<int> IndexOfKeyAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task<System.Int32>

IsExclusivelySticky(Int32)

Declaration

bool IsExclusivelySticky(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Boolean

IsExclusivelyStickyAsync(Int32)

Gets whether the row is allowed to push other sticky rows with the same priority.

Declaration

Task<bool> IsExclusivelyStickyAsync(int row)

Parameters

Type	Name	Description
System.Int32	row	The index of the row to get the exclusivity for.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsPlaceholderItem(Int32)

Declaration

bool IsPlaceholderItem(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Boolean

IsPlaceholderItemAsync(Int32)

Returns true if the item at the requested index is a placeholder item and has not been actualized.

Declaration

Task<bool> IsPlaceholderItemAsync(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsRowPinned(Int32)

Declaration

bool IsRowPinned(int row)

Parameters

Type	Name	Description
System.Int32	row

Returns

Type	Description
System.Boolean

IsRowPinnedAsync(Int32)

Returns whether the row is pinned.

Declaration

Task<bool> IsRowPinnedAsync(int row)

Parameters

Type	Name	Description
System.Int32	row	The index of the row.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsRowSpanning(DataSourceRowType)

Declaration

bool IsRowSpanning(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType

Returns

Type	Description
System.Boolean

IsRowSpanningAsync(DataSourceRowType)

Returns whether the requested row type is considered a spanning element for the data source. Spanning elements have a single complex value rather than the current schema of the data source.

Declaration

Task<bool> IsRowSpanningAsync(DataSourceRowType rowType)

Parameters

Type	Name	Description
DataSourceRowType	rowType	The row type to check.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

PinRow(Object[])

Declaration

void PinRow(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

PinRowAsync(Object[])

Declaration

Task PinRowAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task

QueueAutoRefresh()

Declaration

void QueueAutoRefresh()

QueueAutoRefreshAsync()

Called to manually queue a refresh of the data source.

Declaration

Task QueueAutoRefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

Declaration

void Refresh()

RefreshAsync()

Called to synchronously refresh the data source.

Declaration

Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task

ResolveSchemaPropertyType(String)

Declaration

DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)

Parameters

Type	Name	Description
System.String	propertyPath

Returns

Type	Description
DataSourceSchemaPropertyType

ResolveSchemaPropertyTypeAsync(String)

Resolve a property or property path to its value type.

Declaration

Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)

Parameters

Type	Name	Description
System.String	propertyPath	The property or property path.

Returns

Type	Description
System.Threading.Tasks.Task<DataSourceSchemaPropertyType>

SetIsRowExpandedAtIndex(Int32, Boolean)

Declaration

void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)

Parameters

Type	Name	Description
System.Int32	rowIndex
System.Boolean	isExpanded

SetIsRowExpandedAtIndexAsync(Int32, Boolean)

Declaration

Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)

Parameters

Type	Name	Description
System.Int32	rowIndex
System.Boolean	isExpanded

Returns

Type	Description
System.Threading.Tasks.Task

UnpinRow(Object[])

Declaration

void UnpinRow(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

UnpinRowAsync(Object[])

Declaration

Task UnpinRowAsync(object[] key)

Parameters

Type	Name	Description
System.Object[]	key

Returns

Type	Description
System.Threading.Tasks.Task