System.Object
IgbGrid
ImplementsSystem.IDisposable
Namespace: IgniteUI.Blazor.Controls Assembly: IgniteUI.Blazor.dll Syntaxpublic class IgbGrid : IgbGridBaseDirective, RefSink, JsonSerializable, IDisposable
Constructors IgbGrid() Declaration Properties Data Declaration
public object Data { get; set; }
Property Value Type Description System.Object DataPreLoad Declaration
public EventCallback<IgbForOfStateEventArgs> DataPreLoad { get; set; }
Property Value DataPreLoadScript Declaration
public string DataPreLoadScript { get; set; }
Property Value Type Description System.String DataScript
Provides a means of setting Data in the JavaScript environment.
Declarationpublic 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
Declarationpublic RenderFragment<IgbGridMasterDetailContext> DetailTemplate { get; set; }
Property Value DetailTemplateScript
Provides a means of setting DetailTemplate in the JavaScript environment.
Declarationpublic 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.
Declarationpublic string DropAreaTemplateScript { get; set; }
Property Value Type Description System.String GroupByRowSelectorTemplate
Gets the group by row selector template.
Declarationpublic RenderFragment<IgbGroupByRowSelectorTemplateContext> GroupByRowSelectorTemplate { get; set; }
Property Value GroupByRowSelectorTemplateScript
Provides a means of setting GroupByRowSelectorTemplate in the JavaScript environment.
Declarationpublic string GroupByRowSelectorTemplateScript { get; set; }
Property Value Type Description System.String GroupingDone Declaration
public EventCallback<IgbGroupingDoneEventArgs> GroupingDone { get; set; }
Property Value GroupingDoneScript Declaration
public string GroupingDoneScript { get; set; }
Property Value Type Description System.String GroupingExpansionState Declaration
public IgbGroupByExpandState[] GroupingExpansionState { get; set; }
Property Value GroupingExpansionStateChange Declaration
public EventCallback<IgbGroupByExpandStateEventArgs> GroupingExpansionStateChange { get; set; }
Property Value GroupingExpansionStateChangeScript Declaration
public string GroupingExpansionStateChangeScript { get; set; }
Property Value Type Description System.String GroupingExpressions Declaration
public IgbGroupingExpression[] GroupingExpressions { get; set; }
Property Value GroupingExpressionsChange Declaration
public EventCallback<IgbGroupingExpressionEventArgs> GroupingExpressionsChange { get; set; }
Property Value GroupingExpressionsChangeScript Declaration
public string GroupingExpressionsChangeScript { get; set; }
Property Value Type Description System.String 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 GroupRowTemplateScript
Provides a means of setting GroupRowTemplate in the JavaScript environment.
Declarationpublic 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 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
Declarationpublic Task BeginAddRowByIndexAsync(double index)
Parameters Type Name Description System.Double index
public void ClearGrouping(string name = null)
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("ID"); //ungroups a single column
this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns
name Name of column or array of column names to be ungrouped.
Declarationpublic Task ClearGroupingAsync(string name = null)
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) Declarationpublic void DeselectRowsInGroup(IgbGroupByRecord groupRow)
Parameters 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() Declarationprotected 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 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) Declarationpublic IgbCellType GetCellByColumn(double rowIndex, string columnField)
Parameters Type Name Description System.Double rowIndex System.String columnField Returns 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 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 GetGroupsRecordsAsync() Declaration
public Task<IgbGroupByRecord[]> GetGroupsRecordsAsync()
Returns GetRowByIndex(Double) Declaration
public IgbRowType GetRowByIndex(double index)
Parameters Type Name Description System.Double index Returns GetRowByIndexAsync(Double)
Returns the IgxGridRow
by index. @example
const myRow = grid.getRowByIndex(1);
index
Declarationpublic 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 GetRowByKeyAsync(Object)
Returns IgxGridRow
object by the specified primary key. @remarks Requires that the primaryKey
property is set. @example
const myRow = this.grid1.getRowByKey("cell5");
keyValue
Declarationpublic 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 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 GroupByAsync(IgbGroupingExpression[]) Declaration
public Task GroupByAsync(IgbGroupingExpression[] expression)
Parameters Returns Type Description System.Threading.Tasks.Task IsExpandedGroup(IgbGroupByRecord) Declaration
public bool IsExpandedGroup(IgbGroupByRecord group)
Parameters 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 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 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 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
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4