Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable

constructor

public IgbGenericInternalVirtualDataSource()

Returns IgbGenericInternalVirtualDataSource

Inherited from: IgbVirtualDataSource

Gets or sets if sections are collapsable.

[Parameter]
public override bool IsSectionCollapsable { get; set; }

Inherited from: IgbVirtualDataSource

Gets or sets whether sections default to expanded or collapsed when they are created.

[Parameter]
public override bool IsSectionExpandedDefault { get; set; }

Inherited from: IgbVirtualDataSource

Gets or sets the desired page size. This may or may not be respected by the underlying provider, or its connected services.

[Parameter]
public int PageSizeRequested { get; set; }

Inherited from: IgbVirtualDataSource

Gets or sets the maximum number of data pages to cache in the data source before the oldest pages will start being evicted.

[Parameter]
public int MaxCachedPages { get; set; }

Inherited from: IgbVirtualDataSource

Gets the actual resolved page size that will be used.

[Parameter]
public int ActualPageSize { get; set; }

Inherited from: IgbVirtualDataSource

Gets or sets the field to use for concurrency. I.e. for odata, RowVersion for sql, etc.

[Parameter]
public string ConcurrencyTag { get; set; }

Inherited from: IgbVirtualDataSource

Gets whether batch edits are enabled. Setting this property will have no effect.

[Parameter]
public override bool IsBatchingEnabled { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether the data source is read-only or not.

[Parameter]
public bool IsReadOnly { get; set; }

Inherited from: IgbBaseDataSource

Gets the current actual full count of the items in the data source.

[Parameter]
public int ActualCount { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets which index consumers of the data source desire to be the current first visible index. A grid, for example, would indicate the current visible top row, and update this as that changes.

[Parameter]
public int FirstVisibleIndexRequested { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets which index consumers of the data source desire to be the current last visible index. A grid, for example, would indicate the current visible top row, and update this as that changes.

[Parameter]
public int LastVisibleIndexRequested { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether the auto refresh mechanism of the data source is currently defered. The data source will not react to most setting changes while this is set to true an will instead defer processing. Setting this value to false will queue a new refresh.

[Parameter]
public bool DeferAutoRefresh { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets a list of property references that indicate the user provided primary key of the items in the data source. Consumers of the data source will often need to uniquely identify items in the data source. For this purpose a primary key should be specified.

[Parameter]
public string[] PrimaryKey { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets a list of property references for the properties desired by the consumer of the data source. If known, the data source may take steps to request only those properties, or to ensure that those properties are included, rather than the default behavior for this type of data source.

[Parameter]
public string[] PropertiesRequested { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets what properties should be included when resolving the datasource schema. If null, all properties are included.

[Parameter]
public string[] SchemaIncludedProperties { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets how section headers are displayed.

[Parameter]
public virtual DataSourceSectionHeaderDisplayMode SectionHeaderDisplayMode { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether the data source should include summary rows inside the group when summaries are present.

[Parameter]
public virtual bool IncludeSummaryRowsInSection { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether the summary rows within a section are placed at the bottom of the section, otherwise they will be placed at the top.

[Parameter]
public virtual bool IsSectionSummaryRowsAtBottom { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether the section headers are treated as normal rows.

[Parameter]
public virtual bool IsSectionHeaderNormalRow { get; set; }

Inherited from: IgbBaseDataSource

Gets or sets whether content besides the section headers are displayed.

[Parameter]
public virtual bool IsSectionContentVisible { get; set; }

Inherited from: IgbBaseDataSource

[Parameter]
public bool ShouldEmitSectionHeaders { get; set; }

Inherited from: IgbBaseDataSource

[Parameter]
public bool ShouldEmitSectionFooters { get; set; }

Inherited from: IgbBaseDataSource

[Parameter]
public bool ShouldEmitShiftedRows { get; set; }

Inherited from: IgbBaseDataSource

[Parameter]
public bool ShouldEmitSummaryRows { get; set; }

Inherited from: BaseRendererElement

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererElement

public bool IsComponentRooted { get; }

Inherited from: BaseRendererElement

protected virtual string ParentTypeName { get; }

Inherited from: BaseRendererElement

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererElement

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererElement

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererElement

[Parameter]
public string Name { get; set; }

Inherited from: BaseRendererElement

public object Parent { get; }

Inherited from: BaseRendererElement

protected virtual string MethodTarget { get; }

Inherited from: BaseRendererElement

protected object CurrParent { get; }
[Parameter]
public bool IsAggregationSupported { get; set; }
[Parameter]
public bool IsClone { get; set; }
public override string Type { get; }

Inherited from: BaseRendererElement

protected string _name

Inherited from: BaseRendererElement

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererElement

protected string _cachedSerializedContent

Inherited from: IgbVirtualDataSource

Returns whether the item at the requested index is a placeholder for a virtual item which has yet to be loaded.

public override Task<bool> IsPlaceholderItemAsync(int index)

Parameters

  • index: int

Returns any

Inherited from: IgbVirtualDataSource

public override bool IsPlaceholderItem(int index)

Parameters

  • index: int

Returns any

Inherited from: IgbVirtualDataSource

Gets the item at the requested index. May return null, in which case you may want to check if that null represents a placeholder for a virtual item.

public override Task<object> GetItemAtIndexAsync(int index)

Parameters

  • index: int

Returns any

Inherited from: IgbVirtualDataSource

public override object GetItemAtIndex(int index)

Parameters

  • index: int

Returns any

Inherited from: IgbVirtualDataSource

public override Task<object> GetItemFromKeyAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override object GetItemFromKey(object[] key)

Parameters

  • key: object[]

Returns any

GetItemPropertyAtIndexAsync(int, string)

Section titled "GetItemPropertyAtIndexAsync(int, string)"

Inherited from: IgbVirtualDataSource

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

Parameters

  • index: int
  • valueName: string

Returns any

GetItemPropertyAtIndex(int, string)

Section titled "GetItemPropertyAtIndex(int, string)"

Inherited from: IgbVirtualDataSource

public override object GetItemPropertyAtIndex(int index, string valueName)

Parameters

  • index: int
  • valueName: string

Returns any

Inherited from: IgbVirtualDataSource

public Task<int[]> TransformPageAsync(int pageIndex)

Parameters

  • pageIndex: int

Returns any

Inherited from: IgbVirtualDataSource

public int[] TransformPage(int pageIndex)

Parameters

  • pageIndex: int

Returns any

Inherited from: IgbVirtualDataSource

Gets the number of unrealized or virtual items.

public virtual Task<int> GetUnrealizedCountAsync()

Returns any

Inherited from: IgbVirtualDataSource

public virtual int GetUnrealizedCount()

Returns any

Inherited from: IgbVirtualDataSource

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.

public override Task<int> IndexOfItemAsync(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbVirtualDataSource

public override int IndexOfItem(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbVirtualDataSource

public override Task<int> IndexOfKeyAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override int IndexOfKey(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override Task<int> GetStickyRowPriorityAsync(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override int GetStickyRowPriority(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override Task UnpinRowAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override void UnpinRow(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override Task PinRowAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override void PinRow(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override Task<bool> IsRowPinnedAsync(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override bool IsRowPinned(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override Task<bool> IsExclusivelyStickyAsync(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override bool IsExclusivelySticky(int row)

Parameters

  • row: int

Returns any

Inherited from: IgbVirtualDataSource

public override Task<DataSourceRowType> GetRowTypeAsync(int rowIndex)

Parameters

  • rowIndex: int

Returns any

Inherited from: IgbVirtualDataSource

public override DataSourceRowType GetRowType(int rowIndex)

Parameters

  • rowIndex: int

Returns any

Inherited from: IgbVirtualDataSource

Gets the expansion state for a row.

public override Task<bool> GetIsRowExpandedAtIndexAsync(int rowIndex)

Parameters

  • rowIndex: int

Returns any

Inherited from: IgbVirtualDataSource

public override bool GetIsRowExpandedAtIndex(int rowIndex)

Parameters

  • rowIndex: int

Returns any

SetIsRowExpandedAtIndexAsync(int, bool)

Section titled "SetIsRowExpandedAtIndexAsync(int, bool)"

Inherited from: IgbVirtualDataSource

public override Task SetIsRowExpandedAtIndexAsync(int rowIndex, bool isExpanded)

Parameters

  • rowIndex: int
  • isExpanded: bool

Returns any

Inherited from: IgbVirtualDataSource

public override void SetIsRowExpandedAtIndex(int rowIndex, bool isExpanded)

Parameters

  • rowIndex: int
  • isExpanded: bool

Returns any

Inherited from: IgbVirtualDataSource

Gets the hierarchy level of the row.

public override Task<int> GetRowLevelAsync(int rowIndex)

Parameters

  • rowIndex: int

Returns any

Inherited from: IgbVirtualDataSource

public override int GetRowLevel(int rowIndex)

Parameters

  • rowIndex: int

Returns any

Inherited from: IgbVirtualDataSource

Gets the number of summary rows at the root level.

public override Task<int> GetRootSummaryRowCountAsync()

Returns any

Inherited from: IgbVirtualDataSource

public override int GetRootSummaryRowCount()

Returns any

Inherited from: IgbVirtualDataSource

Gets the summary results for the root level.

public override Task<IgbDataGridSummaryResult[]> GetRootSummaryResultsAsync()

Returns any

Inherited from: IgbVirtualDataSource

public override IgbDataGridSummaryResult[] GetRootSummaryResults()

Returns any

Inherited from: IgbVirtualDataSource

Gets the summary results for a specific section.

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

Parameters

  • sectionIndex: int

Returns any

Inherited from: IgbVirtualDataSource

public override IgbDataGridSummaryResult[][] GetSectionSummaryResults(int sectionIndex)

Parameters

  • sectionIndex: int

Returns any

Inherited from: IgbVirtualDataSource

Clones the properties over to the provided datasource.

public override Task ClonePropertiesAsync(DataSource dataSource)

Parameters

  • dataSource: DataSource

Returns any

Inherited from: IgbVirtualDataSource

public override void CloneProperties(DataSource dataSource)

Parameters

  • dataSource: DataSource

Returns any

UpdatePropertyAtKeyAsync(object[], string, object, bool)

Section titled "UpdatePropertyAtKeyAsync(object[], string, object, bool)"

Inherited from: IgbVirtualDataSource

public override Task<int> UpdatePropertyAtKeyAsync(object[] key, string propertyPath, object value, bool isPending = false)

Parameters

  • key: object[]
  • propertyPath: string
  • value: object
  • isPending: bool

Returns any

UpdatePropertyAtKey(object[], string, object, bool)

Section titled "UpdatePropertyAtKey(object[], string, object, bool)"

Inherited from: IgbVirtualDataSource

public override int UpdatePropertyAtKey(object[] key, string propertyPath, object value, bool isPending = false)

Parameters

  • key: object[]
  • propertyPath: string
  • value: object
  • isPending: bool

Returns any

Inherited from: IgbVirtualDataSource

public override Task RemoveItemByKeyAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbVirtualDataSource

public override void RemoveItemByKey(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbBaseDataSource

public Task AddItemAsync(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbBaseDataSource

public void AddItem(object item)

Parameters

  • item: object

Returns any

SetCustomizedStringAsync(string, string)

Section titled "SetCustomizedStringAsync(string, string)"

Inherited from: IgbBaseDataSource

Provide a new set of localized strings to use for a given languange.

public Task<object> SetCustomizedStringAsync(string language, string json)

Parameters

  • language: string
  • json: string

Returns any

SetCustomizedStringAsync(string, string, string)

Section titled "SetCustomizedStringAsync(string, string, string)"

Inherited from: IgbBaseDataSource

Provide a new set of localized strings to use for a given languange.

public Task<object> SetCustomizedStringAsync(string language, string id, string value)

Parameters

  • language: string
  • id: string
  • value: string

Returns any

Inherited from: IgbBaseDataSource

Removes an item from the datasource.

public Task RemoveItemAsync(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbBaseDataSource

public void RemoveItem(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbBaseDataSource

Save a specific pending transaction.

public Task AcceptPendingTransactionAsync(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

public void AcceptPendingTransaction(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

Rejects a pending transaction.

public Task RejectPendingTransactionAsync(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

public void RejectPendingTransaction(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

Commit the current edits to the datasource.

public Task<int> CommitEditsAsync(bool isPending)

Parameters

  • isPending: bool

Returns any

Inherited from: IgbBaseDataSource

public int CommitEdits(bool isPending)

Parameters

  • isPending: bool

Returns any

Inherited from: IgbBaseDataSource

Cancels any batched edits that may exist.

public Task CancelEditsAsync()

Returns any

Inherited from: IgbBaseDataSource

public void CancelEdits()

Returns any

Inherited from: IgbBaseDataSource

Accepts a commit with the provided ID.

public Task AcceptPendingCommitAsync(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

public void AcceptPendingCommit(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

Cancel a commit with the provided ID.

public Task RejectPendingCommitAsync(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

public void RejectPendingCommit(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

Undo the last edit.

public Task UndoAsync()

Returns any

Inherited from: IgbBaseDataSource

public void Undo()

Returns any

Inherited from: IgbBaseDataSource

Redo the last undo.

public Task RedoAsync()

Returns any

Inherited from: IgbBaseDataSource

public void Redo()

Returns any

Inherited from: IgbBaseDataSource

public Task<bool> HasEditAsync(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

public bool HasEdit(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

public Task<bool> HasDeleteAsync(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbBaseDataSource

public bool HasDelete(object[] key)

Parameters

  • key: object[]

Returns any

Inherited from: IgbBaseDataSource

Returns whether the item is an uncommitted add.

public Task<bool> HasAddAsync(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbBaseDataSource

public bool HasAdd(object item)

Parameters

  • item: object

Returns any

Inherited from: IgbBaseDataSource

Returns a set of changes that have been made to the data however have not been committed yet.

public Task<IgbDataSourceAggregatedResult[]> GetAggregatedChangesAsync(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

public IgbDataSourceAggregatedResult[] GetAggregatedChanges(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

Returns whether a transaction pending or not.

public Task<bool> IsPendingTransactionAsync(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

public bool IsPendingTransaction(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

Returns whether a commit is pending or not.

public Task<bool> IsPendingCommitAsync(int commitID)

Parameters

  • commitID: int

Returns any

Inherited from: IgbBaseDataSource

public bool IsPendingCommit(int commitID)

Parameters

  • commitID: int

Returns any

SetTransactionErrorAsync(int, string)

Section titled "SetTransactionErrorAsync(int, string)"

Inherited from: IgbBaseDataSource

public Task SetTransactionErrorAsync(int transactionID, string message)

Parameters

  • transactionID: int
  • message: string

Returns any

Inherited from: IgbBaseDataSource

public void SetTransactionError(int transactionID, string message)

Parameters

  • transactionID: int
  • message: string

Returns any

GetTransactionErrorByKeyAsync(object[], string)

Section titled "GetTransactionErrorByKeyAsync(object[], string)"

Inherited from: IgbBaseDataSource

public Task<string> GetTransactionErrorByKeyAsync(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

GetTransactionErrorByKey(object[], string)

Section titled "GetTransactionErrorByKey(object[], string)"

Inherited from: IgbBaseDataSource

public string GetTransactionErrorByKey(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

Returns an error, if any, associated with a specific transaction.

public Task<string> GetTransactionErrorByIDAsync(int transactionID)

Parameters

  • transactionID: int

Returns any

Inherited from: IgbBaseDataSource

public string GetTransactionErrorByID(int transactionID)

Parameters

  • transactionID: int

Returns any

GetTransactionIDAsync(object[], string)

Section titled "GetTransactionIDAsync(object[], string)"

Inherited from: IgbBaseDataSource

public Task<int> GetTransactionIDAsync(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

public int GetTransactionID(object[] key, string propertyPath)

Parameters

  • key: object[]
  • propertyPath: string

Returns any

GetItemPropertyAsync(object, string)

Section titled "GetItemPropertyAsync(object, string)"

Inherited from: IgbBaseDataSource

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

Parameters

  • item: object
  • propertyName: string

Returns any

Inherited from: IgbBaseDataSource

public virtual object GetItemProperty(object item, string propertyName)

Parameters

  • item: object
  • propertyName: string

Returns any

NotifySetItemAsync(int, object, object)

Section titled "NotifySetItemAsync(int, object, object)"

Inherited from: IgbBaseDataSource

public Task NotifySetItemAsync(int index, object oldItem, object newItem)

Parameters

  • index: int
  • oldItem: object
  • newItem: object

Returns any

Inherited from: IgbBaseDataSource

public void NotifySetItem(int index, object oldItem, object newItem)

Parameters

  • index: int
  • oldItem: object
  • newItem: object

Returns any

Inherited from: IgbBaseDataSource

Manually notifies the data source that the data it has bound to has been cleared and needs to be re-examined. This should not be necessary to call if the data that the data source is bound to is already observable.

public Task NotifyClearItemsAsync()

Returns any

Inherited from: IgbBaseDataSource

public void NotifyClearItems()

Returns any

Inherited from: IgbBaseDataSource

public Task NotifyInsertItemAsync(int index, object newItem)

Parameters

  • index: int
  • newItem: object

Returns any

Inherited from: IgbBaseDataSource

public void NotifyInsertItem(int index, object newItem)

Parameters

  • index: int
  • newItem: object

Returns any

Inherited from: IgbBaseDataSource

public Task NotifyRemoveItemAsync(int index, object oldItem)

Parameters

  • index: int
  • oldItem: object

Returns any

Inherited from: IgbBaseDataSource

public void NotifyRemoveItem(int index, object oldItem)

Parameters

  • index: int
  • oldItem: object

Returns any

Inherited from: IgbBaseDataSource

Called to manually queue a refresh of the data source.

public Task QueueAutoRefreshAsync()

Returns any

Inherited from: IgbBaseDataSource

public void QueueAutoRefresh()

Returns any

Inherited from: IgbBaseDataSource

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

public Task FlushAutoRefreshAsync()

Returns any

Inherited from: IgbBaseDataSource

public void FlushAutoRefresh()

Returns any

Inherited from: IgbBaseDataSource

Called to synchronously refresh the data source.

public Task RefreshAsync()

Returns any

Inherited from: IgbBaseDataSource

public void Refresh()

Returns any

GetMainValuePathAsync(DataSourceRowType)

Section titled "GetMainValuePathAsync(DataSourceRowType)"

Inherited from: IgbBaseDataSource

public virtual Task<string> GetMainValuePathAsync(DataSourceRowType rowType)

Parameters

  • rowType: DataSourceRowType

Returns any

GetMainValuePath(DataSourceRowType)

Section titled "GetMainValuePath(DataSourceRowType)"

Inherited from: IgbBaseDataSource

public virtual string GetMainValuePath(DataSourceRowType rowType)

Parameters

  • rowType: DataSourceRowType

Returns any

IsRowSpanningAsync(DataSourceRowType)

Section titled "IsRowSpanningAsync(DataSourceRowType)"

Inherited from: IgbBaseDataSource

public virtual Task<bool> IsRowSpanningAsync(DataSourceRowType rowType)

Parameters

  • rowType: DataSourceRowType

Returns any

Inherited from: IgbBaseDataSource

public virtual bool IsRowSpanning(DataSourceRowType rowType)

Parameters

  • rowType: DataSourceRowType

Returns any

Inherited from: IgbBaseDataSource

public virtual Task ClearPinnedRowsAsync()

Returns any

Inherited from: IgbBaseDataSource

public virtual void ClearPinnedRows()

Returns any

ResolveSchemaPropertyTypeAsync(string)

Section titled "ResolveSchemaPropertyTypeAsync(string)"

Inherited from: IgbBaseDataSource

Resolve a property or property path to its value type.

public virtual Task<DataSourceSchemaPropertyType> ResolveSchemaPropertyTypeAsync(string propertyPath)

Parameters

  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

public virtual DataSourceSchemaPropertyType ResolveSchemaPropertyType(string propertyPath)

Parameters

  • propertyPath: string

Returns any

Inherited from: IgbBaseDataSource

Gets the current actual full count of the items in the data source.

public virtual Task<int> GetRowCountAsync()

Returns any

Inherited from: IgbBaseDataSource

public virtual int GetRowCount()

Returns any

Inherited from: BaseRendererElement

protected virtual void EnsureModulesLoaded()

Returns any

Inherited from: BaseRendererElement

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererElement

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelper(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererElement

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererElement

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererElement

public string Serialize()

Returns any

Inherited from: BaseRendererElement

protected void EnsureValid()

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement

protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"

Inherited from: BaseRendererElement

protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

AddSchemaProperty(string, GenericDataSourceSchemaPropertyType)

Section titled "AddSchemaProperty(string, GenericDataSourceSchemaPropertyType)"
public void AddSchemaProperty(string propertyName, GenericDataSourceSchemaPropertyType propertyType)

Parameters

  • propertyName: string
  • propertyType: GenericDataSourceSchemaPropertyType

Returns any

AddSchemaPropertyAsync(string, GenericDataSourceSchemaPropertyType)

Section titled "AddSchemaPropertyAsync(string, GenericDataSourceSchemaPropertyType)"
public Task AddSchemaPropertyAsync(string propertyName, GenericDataSourceSchemaPropertyType propertyType)

Parameters

  • propertyName: string
  • propertyType: GenericDataSourceSchemaPropertyType

Returns any

AddSummaryDate(string, DataSourceSummaryOperand, DateTime)

Section titled "AddSummaryDate(string, DataSourceSummaryOperand, DateTime)"
public void AddSummaryDate(string propertyName, DataSourceSummaryOperand operand, DateTime value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: DateTime

Returns any

AddSummaryDateAsync(string, DataSourceSummaryOperand, DateTime)

Section titled "AddSummaryDateAsync(string, DataSourceSummaryOperand, DateTime)"
public Task AddSummaryDateAsync(string propertyName, DataSourceSummaryOperand operand, DateTime value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: DateTime

Returns any

AddSummaryDouble(string, DataSourceSummaryOperand, double)

Section titled "AddSummaryDouble(string, DataSourceSummaryOperand, double)"
public void AddSummaryDouble(string propertyName, DataSourceSummaryOperand operand, double value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: double

Returns any

AddSummaryDoubleAsync(string, DataSourceSummaryOperand, double)

Section titled "AddSummaryDoubleAsync(string, DataSourceSummaryOperand, double)"
public Task AddSummaryDoubleAsync(string propertyName, DataSourceSummaryOperand operand, double value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: double

Returns any

AddSummaryInt(string, DataSourceSummaryOperand, int)

Section titled "AddSummaryInt(string, DataSourceSummaryOperand, int)"
public void AddSummaryInt(string propertyName, DataSourceSummaryOperand operand, int value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: int

Returns any

AddSummaryIntAsync(string, DataSourceSummaryOperand, int)

Section titled "AddSummaryIntAsync(string, DataSourceSummaryOperand, int)"
public Task AddSummaryIntAsync(string propertyName, DataSourceSummaryOperand operand, int value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: int

Returns any

AddSummaryString(string, DataSourceSummaryOperand, string)

Section titled "AddSummaryString(string, DataSourceSummaryOperand, string)"
public void AddSummaryString(string propertyName, DataSourceSummaryOperand operand, string value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: string

Returns any

AddSummaryStringAsync(string, DataSourceSummaryOperand, string)

Section titled "AddSummaryStringAsync(string, DataSourceSummaryOperand, string)"
public Task AddSummaryStringAsync(string propertyName, DataSourceSummaryOperand operand, string value)

Parameters

  • propertyName: string
  • operand: DataSourceSummaryOperand
  • value: string

Returns any

public override DataSource Clone()

Returns any

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

public override Task<DataSource> CloneAsync()

Returns any

public void FillColumnBool(string column, bool[] values)

Parameters

  • column: string
  • values: bool[]

Returns any

FillColumnBoolAsync(string, bool[])

Section titled "FillColumnBoolAsync(string, bool[])"
public Task FillColumnBoolAsync(string column, bool[] values)

Parameters

  • column: string
  • values: bool[]

Returns any

public void FillColumnDate(string column, DateTime[] values)

Parameters

  • column: string
  • values: DateTime[]

Returns any

FillColumnDateAsync(string, DateTime[])

Section titled "FillColumnDateAsync(string, DateTime[])"
public Task FillColumnDateAsync(string column, DateTime[] values)

Parameters

  • column: string
  • values: DateTime[]

Returns any

public void FillColumnDouble(string column, double[] values)

Parameters

  • column: string
  • values: double[]

Returns any

FillColumnDoubleAsync(string, double[])

Section titled "FillColumnDoubleAsync(string, double[])"
public Task FillColumnDoubleAsync(string column, double[] values)

Parameters

  • column: string
  • values: double[]

Returns any

public void FillColumnInt(string column, int[] values)

Parameters

  • column: string
  • values: int[]

Returns any

public Task FillColumnIntAsync(string column, int[] values)

Parameters

  • column: string
  • values: int[]

Returns any

public void FillColumnString(string column, string[] values)

Parameters

  • column: string
  • values: string[]

Returns any

FillColumnStringAsync(string, string[])

Section titled "FillColumnStringAsync(string, string[])"
public Task FillColumnStringAsync(string column, string[] values)

Parameters

  • column: string
  • values: string[]

Returns any

public void FillCount(int count)

Parameters

  • count: int

Returns any

Provides the row count for the datasource. The datasource obtains this from the page request so be must be called after FillPageStart.

public Task FillCountAsync(int count)

Parameters

  • count: int

Returns any

public void FillGroupEnd()

Returns any

Ends the current group.

public Task FillGroupEndAsync()

Returns any

public void FillGroupStart(int startIndex, int endIndex)

Parameters

  • startIndex: int
  • endIndex: int

Returns any

public Task FillGroupStartAsync(int startIndex, int endIndex)

Parameters

  • startIndex: int
  • endIndex: int

Returns any

FillGroupValueDate(string, DateTime)

Section titled "FillGroupValueDate(string, DateTime)"
public void FillGroupValueDate(string propertyName, DateTime value)

Parameters

  • propertyName: string
  • value: DateTime

Returns any

FillGroupValueDateAsync(string, DateTime)

Section titled "FillGroupValueDateAsync(string, DateTime)"
public Task FillGroupValueDateAsync(string propertyName, DateTime value)

Parameters

  • propertyName: string
  • value: DateTime

Returns any

FillGroupValueDouble(string, double)

Section titled "FillGroupValueDouble(string, double)"
public void FillGroupValueDouble(string propertyName, double value)

Parameters

  • propertyName: string
  • value: double

Returns any

FillGroupValueDoubleAsync(string, double)

Section titled "FillGroupValueDoubleAsync(string, double)"
public Task FillGroupValueDoubleAsync(string propertyName, double value)

Parameters

  • propertyName: string
  • value: double

Returns any

public void FillGroupValueInt(string propertyName, int value)

Parameters

  • propertyName: string
  • value: int

Returns any

FillGroupValueIntAsync(string, int)

Section titled "FillGroupValueIntAsync(string, int)"
public Task FillGroupValueIntAsync(string propertyName, int value)

Parameters

  • propertyName: string
  • value: int

Returns any

FillGroupValueString(string, string)

Section titled "FillGroupValueString(string, string)"
public void FillGroupValueString(string propertyName, string value)

Parameters

  • propertyName: string
  • value: string

Returns any

FillGroupValueStringAsync(string, string)

Section titled "FillGroupValueStringAsync(string, string)"
public Task FillGroupValueStringAsync(string propertyName, string value)

Parameters

  • propertyName: string
  • value: string

Returns any

public void FillPageEnd()

Returns any

Ends the current page. Must be called after FillPageStart.

public Task FillPageEndAsync()

Returns any

public void FillPageStart(int requestId)

Parameters

  • requestId: int

Returns any

Starts filling a page for the specified request. Must later be followed by FillPageEnd to complete the request.

public Task FillPageStartAsync(int requestId)

Parameters

  • requestId: int

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

[Parameter]
public EventCallback<IgbDataSourceSchemaChangedEventArgs> SchemaChanged { get; set; }
[Parameter]
public EventCallback<IgbDataSourceRowExpansionChangedEventArgs> RowExpansionChanged { get; set; }
[Parameter]
public EventCallback<IgbDataSourceRootSummariesChangedEventArgs> RootSummariesChanged { get; set; }
[Parameter]
public EventCallback<IgbDataSourcePropertiesRequestedChangedEventArgs> PropertiesRequestedChanged { get; set; }
[Parameter]
public EventCallback<IgbPageRequestedEventArgs> PageRequested { get; set; }
[Parameter]
public string SchemaChangedScript { get; set; }
[Parameter]
public string RowExpansionChangedScript { get; set; }
[Parameter]
public string RootSummariesChangedScript { get; set; }
[Parameter]
public string PropertiesRequestedChangedScript { get; set; }
[Parameter]
public string PageRequestedScript { get; set; }