# Ignite UI Grid Lite latest — Full API Reference

> Complete API reference for the Ignite UI Grid Lite package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions.

Platform: Web Components
Package: igniteui-grid-lite
Version: latest

## Classes

### [IgcGridLite](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/classes/IgcGridLite)
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.

- **autoGenerate**: `boolean` — Whether the grid will try to "resolve" its column configuration based on the passed
data source.
- **data**: `T[]` — The data source for the grid.
- **dataPipelineConfiguration**: `DataPipelineConfiguration<T>` — Configuration object which controls remote data operations for the grid.
- **sortingOptions**: `GridLiteSortingOptions` — Sort configuration property for the grid.
- static **styles**: `CSSResult[]` — Array of styles to apply to the element. The styles should be defined
using the css tag function, via constructible stylesheets, or
imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't
support adopted StyleSheets. To use such <style> tags with the style-src
CSP directive, the style-src value must either include 'unsafe-inline' or
nonce-<base64-value> with <base64-value> replaced by a server-generated
nonce.

To provide a nonce to use on generated <style> elements, set
window.litNonce to a server-generated nonce in your page's HTML, before
loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>
- **dataView**: `any` — Returns the state of the data source after sort/filter operations
have been applied.
- **filterExpressions**: `FilterExpression<T>[]` — Get the filter state for the grid.
- **rows**: `IgcGridLiteRow<T>[]` — Returns the collection of rendered row elements in the grid.
- **sortingExpressions**: `SortingExpression<T>[]` — Get the sort state for the grid.
- **totalItems**: `number` — The total number of items in the IgcGridLite.dataView collection.
- **clearFilter**(key?: Keys<T>): void — Resets the current filter state of the control.
- **clearSort**(key?: Keys<T>): void — Resets the current sort state of the control.
- **filter**(config: FilterExpression<T> | FilterExpression<T>[]): void — Performs a filter operation in the grid based on the passed expression(s).
- **getColumn**(id: number | Keys<T>): ColumnConfiguration<T> | undefined — Returns a ColumnConfiguration for a given column.
- **navigateTo**(row: number, column?: Keys<T>, activate: boolean): Promise<void> — Navigates to a position in the grid based on provided row index and column field.
- **sort**(expressions: SortingExpression<T> | SortingExpression<T>[]): void — Performs a sort operation in the grid based on the passed expression(s).

### [IgcGridLiteColumn](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/classes/IgcGridLiteColumn)

- **cellTemplate**: `any` — Custom cell template for the column.
- **dataType**: `"string" | "number" | "boolean"` — The data type of the column's values.
- **field**: `Keys<T>` — The field from the data for this column.
- **filterable**: `boolean` — Indicates whether the column is filterable.
- **filteringCaseSensitive**: `boolean` — Whether filter operations will be case sensitive.
- **header**: `string` — The header text of the column.
- **headerTemplate**: `any` — Custom header template for the column.
- **hidden**: `boolean` — Indicates whether the column is hidden.
- **resizable**: `boolean` — Indicates whether the column is resizable.
- **sortable**: `boolean` — Indicates whether the column is sortable.
- **sortConfiguration**: `ColumnSortConfiguration<T>` — Sort configuration for the column (e.g., custom comparer).
- **sortingCaseSensitive**: `boolean` — Whether sort operations will be case sensitive.
- **width**: `string` — The width of the column.
- static **styles**: `CSSResult` — Array of styles to apply to the element. The styles should be defined
using the css tag function, via constructible stylesheets, or
imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn't
support adopted StyleSheets. To use such <style> tags with the style-src
CSP directive, the style-src value must either include 'unsafe-inline' or
nonce-<base64-value> with <base64-value> replaced by a server-generated
nonce.

To provide a nonce to use on generated <style> elements, set
window.litNonce to a server-generated nonce in your page's HTML, before
loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

## Interfaces

### [BaseColumnConfiguration](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/BaseColumnConfiguration)
Configuration object for grid columns.

- **cellTemplate?**: `any` — Cell template callback.
- **dataType?**: `DataType` — The type of data this column will reference.

Affects the default filter operands if the column is with filtering enabled.
- **field**: `K` — The field from the data for this column.
- **filterable?**: `boolean` — Whether the column can be filtered.
- **filteringCaseSensitive?**: `boolean` — Whether the filter operations will be case sensitive.
- **header?**: `string` — Optional text to display in the column header. By default, the column field is used
to render the header text.
- **headerTemplate?**: `any` — Header template callback.
- **hidden?**: `boolean` — Whether the column is hidden or not.
- **resizable?**: `boolean` — Whether the the column can be resized or not.
- **sortable?**: `boolean` — Whether the column can be sorted.
- **sortConfiguration?**: `ColumnSortConfiguration<T, K>` — Sort configuration options for the column (e.g., custom comparer).
- **sortingCaseSensitive?**: `boolean` — Whether the sort operations will be case sensitive.
- **width?**: `string` — Width for the current column.

Accepts most CSS units for controlling width.

### [BaseColumnSortConfiguration](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/BaseColumnSortConfiguration)
Extended sort configuration for a column.

- **comparer?**: `SortComparer<T, K>` — Custom comparer function for sort operations for this column.

### [BaseFilterExpression](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/BaseFilterExpression)
Represents a filter operation for a given column.

- **caseSensitive?**: `boolean` — Whether the sort operation should be case sensitive.
- **condition**: `FilterOperation<PropertyType<T, K>> | OperandKeys<PropertyType<T, K>>` — The filter function which will be executed against the data records.
- **criteria?**: `FilterCriteria` — Dictates how this expression should resolve in the filter operation in relation to
other expressions.
- **key**: `K` — The target column for the filter operation.
- **searchTerm?**: `PropertyType<T, K>` — The filtering value used in the filter condition function.

### [BaseIgcCellContext](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/BaseIgcCellContext)
Context object for the row cell template callback.

- **column**: `ColumnConfiguration<T, K>` — The current configuration for the column.
- **parent**: `IgcGridLiteCell<T>` — The cell element parent of the template.
- **row**: `IgcGridLiteRow<T>` — The row element containing the cell.
- **value**: `PropertyType<T, K>` — The value from the data source for this cell.

### [BaseSortingExpression](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/BaseSortingExpression)
Represents a sort operation for a given column.

- **caseSensitive?**: `boolean` — Whether the sort operation should be case sensitive.
- **comparer?**: `SortComparer<T, K>` — Custom comparer function for this operation.
- **direction**: `SortingDirection` — Sort direction for this operation.
- **key**: `K` — The target column.

### [DataPipelineConfiguration](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/DataPipelineConfiguration)
Configuration for customizing the various data operations of the grid.

- **filter?**: `DataPipelineHook<T>` — Hook for customizing filter operations.
- **sort?**: `DataPipelineHook<T>` — Hook for customizing sort operations.

### [GridLiteSortingOptions](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/GridLiteSortingOptions)
Configures the sort behavior for the grid.

- **mode**: `"single" | "multiple"` — The sorting mode - either 'single' or 'multiple' column sorting.

### [IgcFilteredEvent](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/IgcFilteredEvent)
Event object for the filtered event of the grid.

- **key**: `Keys<T>` — The target column for the filter operation.
- **state**: `FilterExpression<T>[]` — The filter state of the column after the operation.

### [IgcFilteringEvent](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/IgcFilteringEvent)
Event object for the filtering event of the grid.

- **expressions**: `FilterExpression<T>[]` — The filter expression(s) to apply.
- **key**: `Keys<T>` — The target column for the filter operation.
- **type**: `"remove" | "add" | "modify"` — The type of modification which will be applied to the filter
state of the column.

### [IgcGridLiteEventMap](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/IgcGridLiteEventMap)
Events for the igc-grid-lite.

- **filtered**: `CustomEvent<IgcFilteredEvent<T>>` — Emitted when a filter operation initiated through the UI has completed.
Returns the filter state for the affected column.
- **filtering**: `CustomEvent<IgcFilteringEvent<T>>` — Emitted when filtering is initiated through the UI.
- **sorted**: `CustomEvent<SortingExpression<T, any>>` — Emitted when a sort operation initiated through the UI has completed.
Returns the sort expression used for the operation.
- **sorting**: `CustomEvent<SortingExpression<T, any>>` — Emitted when sorting is initiated through the UI.
Returns the sort expression which will be used for the operation.

### [IgcHeaderContext](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/interfaces/IgcHeaderContext)
Context object for the column header template callback.

- **column**: `ColumnConfiguration<T, any> | ColumnConfiguration<T, Exclude<any & string, any>> | ColumnConfiguration<T, Exclude<any, any>>` — The current configuration for the column.
- **parent**: `IgcGridLiteHeader<T>` — The header element parent of the template.

## Type Aliases

### [BaseSortComparer](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/BaseSortComparer)
`any`
Custom comparer function for a given column used when sorting is performed.

### [ColumnConfiguration](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/ColumnConfiguration)
`any`
See BaseColumnConfiguration for the full documentation.

### [ColumnSortConfiguration](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/ColumnSortConfiguration)
`any`
See BaseColumnSortConfiguration for the full documentation.

### [DataPipelineHook](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/DataPipelineHook)
`any`
Callback function for customizing data operations in the grid.

### [DataPipelineParams](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/DataPipelineParams)
`any`
The parameters passed to a DataPipelineHook callback.

### [DataType](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/DataType)
`"number" | "string" | "boolean"`
The data for the current column.

### [FilterCriteria](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/FilterCriteria)
`"and" | "or"`
Controls how a data record should resolve in a filter operation:
 - 'and' - the record must pass all the conditions.
 - 'or'  - the record must pass at least one condition.

### [FilterExpression](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/FilterExpression)
`any`
See BaseFilterExpression for the full documentation.

### [IgcCellContext](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/IgcCellContext)
`any`
See BaseIgcCellContext for the full documentation.

### [Keys](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/Keys)
`FlatKeys<T> | NestedKeys<T>`
Helper type for resolving keys of type T.

### [PropertyType](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/PropertyType)
`any`
Helper type for resolving types of type T.

### [SortComparer](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/SortComparer)
`any`
See BaseSortComparer for the full documentation.

### [SortingDirection](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/SortingDirection)
`"ascending" | "descending" | "none"`
Sort direction for a given sort expression.

### [SortingExpression](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/SortingExpression)
`any`
See BaseSortingExpression for the full documentation.

### [SortState](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/types/SortState)
`Map<Keys<T>, SortingExpression<T>>`
Represents the sort state of the grid.
