IgcGridLite is a web component for displaying data in a tabular format quick and easy.
Out of the box it provides row virtualization, sort and filter operations (client and server side), the ability to template cells and headers and column hiding.
Properties
Section titled "Properties"autoGenerate
Section titled "autoGenerate"Whether the grid will try to "resolve" its column configuration based on the passed data source.
autoGenerate: booleancolumns
Section titled "columns"Sets the column configuration for the grid.
columns: ColumnConfiguration<T>[]dataPipelineConfiguration
Section titled "dataPipelineConfiguration"Configuration object which controls remote data operations for the grid.
dataPipelineConfiguration: DataPipelineConfiguration<T>filterExpressions
Section titled "filterExpressions"Set the filter state for the grid.
filterExpressions: FilterExpression<T>[]sortingExpressions
Section titled "sortingExpressions"Set the sort state for the grid.
sortingExpressions: SortingExpression<T>[]sortingOptions
Section titled "sortingOptions"Sort configuration property for the grid.
sortingOptions: GridLiteSortingOptionsAccessors
Section titled "Accessors"dataView
Section titled "dataView"Returns the state of the data source after sort/filter operations have been applied.
get dataView(): readonly T[]
Returns readonly T[]
Returns the collection of rendered row elements in the grid.
get rows(): IgcGridLiteRow<T>[]
Returns IgcGridLiteRow<T>[]
totalItems
Section titled "totalItems"[object Object],[object Object],[object Object]
get totalItems(): number
Returns number
Methods
Section titled "Methods"clearFilter
Section titled "clearFilter"Resets the current filter state of the control.
clearFilter(key: Keys<T>): voidParameters
- key:
Keys<T>
Returns void
clearSort
Section titled "clearSort"Resets the current sort state of the control.
clearSort(key: Keys<T>): voidParameters
- key:
Keys<T>
Returns void
filter
Section titled "filter"Performs a filter operation in the grid based on the passed expression(s).
filter(config: FilterExpression<T> | FilterExpression<T>[]): voidParameters
- config:
FilterExpression<T> | FilterExpression<T>[]
Returns void
getColumn
Section titled "getColumn"Returns a ColumnConfiguration for a given column.
getColumn(id: number | Keys<T>): ColumnConfiguration<T> | undefinedParameters
- id:
number | Keys<T>
Returns ColumnConfiguration<T> | undefined
navigateTo
Section titled "navigateTo"Navigates to a position in the grid based on provided row index and column field.
navigateTo(row: number, options: NavigateToOptions<T>): Promise<void>Parameters
- row:
numberThe row index to navigate to
- options:
NavigateToOptions<T>The column field to navigate to and whether to activate the cell
Returns Promise<void>
Performs a sort operation in the grid based on the passed expression(s).
sort(expressions: SortingExpression<T> | SortingExpression<T>[]): voidParameters
- expressions:
SortingExpression<T> | SortingExpression<T>[]
Returns void
Events
Section titled "Events"onFiltered
Section titled "onFiltered"onFiltered(args: CustomEvent<IgrFilteredEvent<any>>): voidParameters
- args:
CustomEvent<IgrFilteredEvent<any>>
Returns void
onFiltering
Section titled "onFiltering"onFiltering(args: CustomEvent<IgrFilteringEvent<any>>): voidParameters
- args:
CustomEvent<IgrFilteringEvent<any>>
Returns void
onSorted
Section titled "onSorted"onSorted(args: CustomEvent<BaseSortingExpression<any, any>>): voidParameters
- args:
CustomEvent<BaseSortingExpression<any, any>>
Returns void
onSorting
Section titled "onSorting"onSorting(args: CustomEvent<BaseSortingExpression<any, any>>): voidParameters
- args:
CustomEvent<BaseSortingExpression<any, any>>