Class IgbGrid

Inheritance
System.Object
BaseRendererControl
IgbGridBaseDirective
IgbGrid
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbGrid : IgbGridBaseDirective, RefSink, JsonSerializable, IDisposable

Constructors

IgbGrid()

Declaration
public IgbGrid()

Properties

Data

Declaration
public object Data { get; set; }
Property Value
Type Description
System.Object

DataPreLoad

Declaration
public EventCallback<IgbForOfStateEventArgs> DataPreLoad { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbForOfStateEventArgs>

DataPreLoadScript

Declaration
public string DataPreLoadScript { get; set; }
Property Value
Type Description
System.String

DataScript

Provides a means of setting Data in the JavaScript environment.

Declaration
public string DataScript { get; set; }
Property Value
Type Description
System.String

DetailTemplate

Returns a reference to the master-detail template.

let detailTemplate = this.grid.detailTemplate;

@memberof IgxColumnComponent

Declaration
public RenderFragment<IgbGridMasterDetailContext> DetailTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGridMasterDetailContext>

DetailTemplateScript

Provides a means of setting DetailTemplate in the JavaScript environment.

Declaration
public string DetailTemplateScript { get; set; }
Property Value
Type Description
System.String

DropAreaMessage

Declaration
public string DropAreaMessage { get; set; }
Property Value
Type Description
System.String

DropAreaTemplate

Declaration
public RenderFragment<object> DropAreaTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>

DropAreaTemplateScript

Provides a means of setting DropAreaTemplate in the JavaScript environment.

Declaration
public string DropAreaTemplateScript { get; set; }
Property Value
Type Description
System.String

GroupByRowSelectorTemplate

Gets the group by row selector template.

Declaration
public RenderFragment<IgbGroupByRowSelectorTemplateContext> GroupByRowSelectorTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGroupByRowSelectorTemplateContext>

GroupByRowSelectorTemplateScript

Provides a means of setting GroupByRowSelectorTemplate in the JavaScript environment.

Declaration
public string GroupByRowSelectorTemplateScript { get; set; }
Property Value
Type Description
System.String

GroupingDone

Declaration
public EventCallback<IgbGroupingDoneEventArgs> GroupingDone { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbGroupingDoneEventArgs>

GroupingDoneScript

Declaration
public string GroupingDoneScript { get; set; }
Property Value
Type Description
System.String

GroupingExpansionState

Declaration
public IgbGroupByExpandState[] GroupingExpansionState { get; set; }
Property Value
Type Description
IgbGroupByExpandState[]

GroupingExpressions

Declaration
public IgbGroupingExpression[] GroupingExpressions { get; set; }
Property Value
Type Description
IgbGroupingExpression[]

GroupRowTemplate

Gets/Sets the template reference for the group row. @example

const groupRowTemplate = this.grid.groupRowTemplate;
this.grid.groupRowTemplate = myRowTemplate;
Declaration
public RenderFragment<IgbGroupByRowTemplateContext> GroupRowTemplate { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment<IgbGroupByRowTemplateContext>

GroupRowTemplateScript

Provides a means of setting GroupRowTemplate in the JavaScript environment.

Declaration
public string GroupRowTemplateScript { get; set; }
Property Value
Type Description
System.String

GroupsExpanded

Declaration
public bool GroupsExpanded { get; set; }
Property Value
Type Description
System.Boolean

GroupStrategy

Declaration
public IgbGridGroupingStrategy GroupStrategy { get; set; }
Property Value
Type Description
IgbGridGroupingStrategy

HideGroupedColumns

Declaration
public bool HideGroupedColumns { get; set; }
Property Value
Type Description
System.Boolean

Id

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

ShowGroupArea

Declaration
public bool ShowGroupArea { get; set; }
Property Value
Type Description
System.Boolean

TotalItemCount

Gets/Sets the total number of records in the data source. @remarks This property is required for remote grid virtualization to function when it is bound to remote data. @example

const itemCount = this.grid1.totalItemCount;
this.grid1.totalItemCount = 55;
Declaration
public double TotalItemCount { get; set; }
Property Value
Type Description
System.Double

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

Methods

BeginAddRowByIndex(Double)

Declaration
public void BeginAddRowByIndex(double index)
Parameters
Type Name Description
System.Double index

BeginAddRowByIndexAsync(Double)

Enters add mode by spawning the UI at the specified index. @remarks Accepted values for index are integers from 0 to this.grid.dataView.length @example

this.grid.beginAddRowByIndex(0);

index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length

Declaration
public Task BeginAddRowByIndexAsync(double index)
Parameters
Type Name Description
System.Double index
  • The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length
Returns
Type Description
System.Threading.Tasks.Task

ClearGrouping(String)

Declaration
public void ClearGrouping(string name)
Parameters
Type Name Description
System.String name

ClearGroupingAsync(String)

Clears grouping for particular column, array of columns or all columns. @remarks Clears all grouping in the grid, if no parameter is passed. If a parameter is provided, clears grouping for a particular column or an array of columns. @example

this.grid.clearGrouping(); //clears all grouping
this.grid.clearGrouping(&quot;ID&quot;); //ungroups a single column
this.grid.clearGrouping([&quot;ID&quot;, &quot;Column1&quot;, &quot;Column2&quot;]); //ungroups multiple columns

name Name of column or array of column names to be ungrouped.

Declaration
public Task ClearGroupingAsync(string name)
Parameters
Type Name Description
System.String name

Name of column or array of column names to be ungrouped.
Returns
Type Description
System.Threading.Tasks.Task

DeselectRowsInGroup(IgbGroupByRecord)

Declaration
public void DeselectRowsInGroup(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

DeselectRowsInGroupAsync(IgbGroupByRecord)

Deselect all rows within a group. groupRow The group record which rows would be deselected. @example

public groupRow: IGroupByRecord;
this.grid.deselectRowsInGroup(this.groupRow);
Declaration
public Task DeselectRowsInGroupAsync(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

The group record which rows would be deselected.
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

FullyExpandGroup(IgbGroupByRecord)

Declaration
public void FullyExpandGroup(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

FullyExpandGroupAsync(IgbGroupByRecord)

Expands the specified group and all of its parent groups. groupRow The group record to fully expand. @example

public groupRow: IGroupByRecord;
this.grid.fullyExpandGroup(this.groupRow);
Declaration
public Task FullyExpandGroupAsync(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

The group record to fully expand.
Returns
Type Description
System.Threading.Tasks.Task

GetCellByColumn(Double, String)

Declaration
public IgbCellType GetCellByColumn(double rowIndex, string columnField)
Parameters
Type Name Description
System.Double rowIndex
System.String columnField
Returns
Type Description
IgbCellType

GetCellByColumnAsync(Double, String)

Declaration
public Task<IgbCellType> GetCellByColumnAsync(double rowIndex, string columnField)
Parameters
Type Name Description
System.Double rowIndex
System.String columnField
Returns
Type Description
System.Threading.Tasks.Task<IgbCellType>

GetCellByKey(Object, String)

Declaration
public IgbCellType GetCellByKey(object rowSelector, string columnField)
Parameters
Type Name Description
System.Object rowSelector
System.String columnField
Returns
Type Description
IgbCellType

GetCellByKeyAsync(Object, String)

Declaration
public Task<IgbCellType> GetCellByKeyAsync(object rowSelector, string columnField)
Parameters
Type Name Description
System.Object rowSelector
System.String columnField
Returns
Type Description
System.Threading.Tasks.Task<IgbCellType>

GetData()

Declaration
protected override object GetData()
Returns
Type Description
System.Object
Overrides

GetGroupsRecords()

Declaration
public IgbGroupByRecord[] GetGroupsRecords()
Returns
Type Description
IgbGroupByRecord[]

GetGroupsRecordsAsync()

Declaration
public Task<IgbGroupByRecord[]> GetGroupsRecordsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbGroupByRecord[]>

GetRowByIndex(Double)

Declaration
public IgbRowType GetRowByIndex(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
IgbRowType

GetRowByIndexAsync(Double)

Returns the IgxGridRow by index. @example

const myRow = grid.getRowByIndex(1);

index

Declaration
public Task<IgbRowType> GetRowByIndexAsync(double index)
Parameters
Type Name Description
System.Double index
Returns
Type Description
System.Threading.Tasks.Task<IgbRowType>

GetRowByKey(Object)

Declaration
public IgbRowType GetRowByKey(object key)
Parameters
Type Name Description
System.Object key
Returns
Type Description
IgbRowType

GetRowByKeyAsync(Object)

Returns IgxGridRow object by the specified primary key. @remarks Requires that the primaryKey property is set. @example

const myRow = this.grid1.getRowByKey(&quot;cell5&quot;);

keyValue

Declaration
public Task<IgbRowType> GetRowByKeyAsync(object key)
Parameters
Type Name Description
System.Object key
Returns
Type Description
System.Threading.Tasks.Task<IgbRowType>

GetSelectedCells()

Declaration
public IgbCellType[] GetSelectedCells()
Returns
Type Description
IgbCellType[]

GetSelectedCellsAsync()

Declaration
public Task<IgbCellType[]> GetSelectedCellsAsync()
Returns
Type Description
System.Threading.Tasks.Task<IgbCellType[]>

GetSelectedData(Boolean, Boolean)

Declaration
public object[] GetSelectedData(bool formatters = false, bool headers = false)
Parameters
Type Name Description
System.Boolean formatters
System.Boolean headers
Returns
Type Description
System.Object[]

GetSelectedDataAsync(Boolean, Boolean)

Declaration
public Task<object[]> GetSelectedDataAsync(bool formatters = false, bool headers = false)
Parameters
Type Name Description
System.Boolean formatters
System.Boolean headers
Returns
Type Description
System.Threading.Tasks.Task<System.Object[]>

GroupBy(IgbGroupingExpression[])

Declaration
public void GroupBy(IgbGroupingExpression[] expression)
Parameters
Type Name Description
IgbGroupingExpression[] expression

GroupByAsync(IgbGroupingExpression[])

Declaration
public Task GroupByAsync(IgbGroupingExpression[] expression)
Parameters
Type Name Description
IgbGroupingExpression[] expression
Returns
Type Description
System.Threading.Tasks.Task

IsExpandedGroup(IgbGroupByRecord)

Declaration
public bool IsExpandedGroup(IgbGroupByRecord group)
Parameters
Type Name Description
IgbGroupByRecord group
Returns
Type Description
System.Boolean

IsExpandedGroupAsync(IgbGroupByRecord)

Returns if a group is expanded or not. group The group record. @example

public groupRow: IGroupByRecord;
const expandedGroup = this.grid.isExpandedGroup(this.groupRow);
Declaration
public Task<bool> IsExpandedGroupAsync(IgbGroupByRecord group)
Parameters
Type Name Description
IgbGroupByRecord group

The group record.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

PinRow(Object, Double)

Declaration
public bool PinRow(object rowID, double index = -1)
Parameters
Type Name Description
System.Object rowID
System.Double index
Returns
Type Description
System.Boolean

PinRowAsync(Object, Double)

Declaration
public Task<bool> PinRowAsync(object rowID, double index = -1)
Parameters
Type Name Description
System.Object rowID
System.Double index
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

SelectRowsInGroup(IgbGroupByRecord, Boolean)

Declaration
public void SelectRowsInGroup(IgbGroupByRecord groupRow, bool clearPrevSelection = false)
Parameters
Type Name Description
IgbGroupByRecord groupRow
System.Boolean clearPrevSelection

SelectRowsInGroupAsync(IgbGroupByRecord, Boolean)

Declaration
public Task SelectRowsInGroupAsync(IgbGroupByRecord groupRow, bool clearPrevSelection = false)
Parameters
Type Name Description
IgbGroupByRecord groupRow
System.Boolean clearPrevSelection
Returns
Type Description
System.Threading.Tasks.Task

ToggleAllGroupRows()

Declaration
public void ToggleAllGroupRows()

ToggleAllGroupRowsAsync()

Toggles the expansion state of all group rows recursively. @example

this.grid.toggleAllGroupRows;
Declaration
public Task ToggleAllGroupRowsAsync()
Returns
Type Description
System.Threading.Tasks.Task

ToggleGroup(IgbGroupByRecord)

Declaration
public void ToggleGroup(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

ToggleGroupAsync(IgbGroupByRecord)

Toggles the expansion state of a group. groupRow The group record to toggle. @example

public groupRow: IGroupByRecord;
const toggleExpGroup = this.grid.toggleGroup(this.groupRow);
Declaration
public Task ToggleGroupAsync(IgbGroupByRecord groupRow)
Parameters
Type Name Description
IgbGroupByRecord groupRow

The group record to toggle.
Returns
Type Description
System.Threading.Tasks.Task

UnpinRow(Object)

Declaration
public bool UnpinRow(object rowID)
Parameters
Type Name Description
System.Object rowID
Returns
Type Description
System.Boolean

UnpinRowAsync(Object)

Declaration
public Task<bool> UnpinRowAsync(object rowID)
Parameters
Type Name Description
System.Object rowID
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

Implements

System.IDisposable