import * as i0 from "@angular/core"; import { OnInit, TemplateRef } from "@angular/core"; import { ColumnConfiguration, ColumnSortConfiguration, DataPipelineConfiguration, DataType, FilterExpression, GridLiteSortingOptions, IgcCellContext, IgcGridLite, IgcHeaderContext, Keys, NavigateToOptions, SortingExpression } from "igniteui-grid-lite"; /** Configuration object for grid columns. */ export type IgxGridLiteColumnConfiguration = ColumnConfiguration; export type IgxGridLiteColumnSortConfiguration = ColumnSortConfiguration; /** * Directive providing type information for header template contexts. * Use this directive on ng-template elements that render header templates. * * @example * ```html * *
{{column.header}}
*
* ``` */ export declare class IgxGridLiteHeaderTemplateDirective { template: TemplateRef>; static ngTemplateContextGuard(_: IgxGridLiteHeaderTemplateDirective, ctx: any): ctx is IgxGridLiteHeaderTemplateContext; static ɵfac: i0.ɵɵFactoryDeclaration, never>; static ɵdir: i0.ɵɵDirectiveDeclaration, "[igxGridLiteHeader]", never, {}, {}, never, never, true, never>; } /** * Directive providing type information for cell template contexts. * Use this directive on ng-template elements that render cell templates. * * @example * ```html * *
{{value}}
*
* ``` */ export declare class IgxGridLiteCellTemplateDirective { template: TemplateRef>; static ngTemplateContextGuard(_: IgxGridLiteCellTemplateDirective, ctx: unknown): ctx is IgxGridLiteCellTemplateContext; static ɵfac: i0.ɵɵFactoryDeclaration, never>; static ɵdir: i0.ɵɵDirectiveDeclaration, "[igxGridLiteCell]", never, {}, {}, never, never, true, never>; } export declare class IgxGridLiteColumnComponent { private readonly _view; /** Reference to the embedded view for the header template and its template function. */ private headerViewRef?; protected headerTemplateFunc?: (ctx: IgcHeaderContext) => Node[]; /** * Embedded views for the cell template, one per cell element, and the template function. * Keyed by cell, not by row data: the virtualizer recycles rows by index, so a cell can * show another record without re-rendering, while a view keyed by data would move away. */ private cellViewRefs?; protected cellTemplateFunc?: (ctx: IgcCellContext) => Node[]; /** Template directives used for inline templating */ private readonly headerTemplateDirective; private readonly cellTemplateDirective; /** The field from the data for this column. */ readonly field: import("@angular/core").InputSignal> | undefined>; /** The data type of the column's values. */ readonly dataType: import("@angular/core").InputSignal; /** The header text of the column. */ readonly header: import("@angular/core").InputSignal; /** The width of the column. */ readonly width: import("@angular/core").InputSignal; /** Indicates whether the column is hidden. */ readonly hidden: import("@angular/core").InputSignalWithTransform; /** Indicates whether the column is resizable. */ readonly resizable: import("@angular/core").InputSignalWithTransform; /** Indicates whether the column is sortable. */ readonly sortable: import("@angular/core").InputSignalWithTransform; /** Whether sort operations will be case sensitive. */ readonly sortingCaseSensitive: import("@angular/core").InputSignalWithTransform; /** Sort configuration for the column (e.g., custom comparer). */ readonly sortConfiguration: import("@angular/core").InputSignal | undefined>; /** Indicates whether the column is filterable. */ readonly filterable: import("@angular/core").InputSignalWithTransform; /** Whether filter operations will be case sensitive. */ readonly filteringCaseSensitive: import("@angular/core").InputSignalWithTransform; /** Custom header template for the column. */ readonly headerTemplate: import("@angular/core").InputSignal> | undefined>; /** Custom cell template for the column. */ readonly cellTemplate: import("@angular/core").InputSignal> | undefined>; constructor(); static ɵfac: i0.ɵɵFactoryDeclaration, never>; static ɵcmp: i0.ɵɵComponentDeclaration, "igx-grid-lite-column", never, { "field": { "alias": "field"; "required": false; "isSignal": true; }; "dataType": { "alias": "dataType"; "required": false; "isSignal": true; }; "header": { "alias": "header"; "required": false; "isSignal": true; }; "width": { "alias": "width"; "required": false; "isSignal": true; }; "hidden": { "alias": "hidden"; "required": false; "isSignal": true; }; "resizable": { "alias": "resizable"; "required": false; "isSignal": true; }; "sortable": { "alias": "sortable"; "required": false; "isSignal": true; }; "sortingCaseSensitive": { "alias": "sortingCaseSensitive"; "required": false; "isSignal": true; }; "sortConfiguration": { "alias": "sortConfiguration"; "required": false; "isSignal": true; }; "filterable": { "alias": "filterable"; "required": false; "isSignal": true; }; "filteringCaseSensitive": { "alias": "filteringCaseSensitive"; "required": false; "isSignal": true; }; "headerTemplate": { "alias": "headerTemplate"; "required": false; "isSignal": true; }; "cellTemplate": { "alias": "cellTemplate"; "required": false; "isSignal": true; }; }, {}, ["headerTemplateDirective", "cellTemplateDirective"], never, true, never>; } /** * Context provided to the header template. */ export type IgxGridLiteHeaderTemplateContext = IgcHeaderContext & { /** * The current configuration for the column. */ $implicit: IgcHeaderContext['column']; }; /** * Context provided to the header template. */ export type IgxGridLiteCellTemplateContext = IgcCellContext & { /** * The value from the data source for this cell. */ $implicit: IgcCellContext['value']; }; export type IgxGridLiteSortingOptions = GridLiteSortingOptions; export type IgxGridLiteDataPipelineConfiguration = DataPipelineConfiguration; export type IgxGridLiteSortingExpression = SortingExpression; export type IgxGridLiteFilteringExpression = FilterExpression; export type IgxGridLiteNavigateToOptions = NavigateToOptions; /** * The Grid Lite 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. * * @fires sorting - Emitted when sorting is initiated through the UI. * @fires sorted - Emitted when a sort operation initiated through the UI has completed. * @fires filtering - Emitted when filtering is initiated through the UI. * @fires filtered - Emitted when a filter operation initiated through the UI has completed. * * @developerPreview 21.1.0 */ export declare class IgxGridLiteComponent implements OnInit { private readonly gridRef; /** The data source for the grid. */ readonly data: import("@angular/core").InputSignal; /** * Whether the grid will try to "resolve" its column configuration based on the passed * data source. * * @remarks * This property is ignored if any existing column configuration already exists in the grid. */ readonly autoGenerate: import("@angular/core").InputSignalWithTransform; /** Sort configuration property for the grid. */ readonly sortingOptions: import("@angular/core").InputSignal; /** * Configuration object which controls remote data operations for the grid. */ readonly dataPipelineConfiguration: import("@angular/core").InputSignal | undefined>; /** * The sort state for the grid. * * @remarks * This is a two-way bindable property. It will be updated when sort operations * complete through the UI. */ readonly sortingExpressions: import("@angular/core").ModelSignal[]>; /** * The filter state for the grid. * * @remarks * This is a two-way bindable property. It will be updated when filter operations * complete through the UI. */ readonly filteringExpressions: import("@angular/core").ModelSignal[]>; /** * Get the column configuration of the grid. */ get columns(): IgxGridLiteColumnConfiguration[]; /** * Returns the collection of rendered row elements in the grid. * * @remarks * Since the grid has virtualization, this property returns only the currently rendered * chunk of elements in the DOM. */ get rows(): IgcGridLite['rows']; /** * Returns the state of the data source after sort/filter operations * have been applied. */ get dataView(): ReadonlyArray; constructor(); /** * @hidden @internal */ ngOnInit(): void; /** * Performs a filter operation in the grid based on the passed expression(s). */ filter(config: IgxGridLiteFilteringExpression | IgxGridLiteFilteringExpression[]): void; /** * Performs a sort operation in the grid based on the passed expression(s). */ sort(expressions: IgxGridLiteSortingExpression | IgxGridLiteSortingExpression[]): void; /** * Resets the current sort state of the control. */ clearSort(key?: Keys): void; /** * Resets the current filter state of the control. */ clearFilter(key?: Keys): void; /** * Navigates to a position in the grid based on provided row index and column field. * @param row The row index to navigate to * @param options The column field to navigate to and whether to activate the cell * @returns A promise that resolves when navigation completes. */ navigateTo(row: number, options?: IgxGridLiteNavigateToOptions): Promise; /** * Navigates to a position in the grid based on provided row index and column field. * @param row The row index to navigate to * @param column The column field to navigate to, if any * @param activate Optionally also activate the navigated cell * @deprecated Use `navigateTo(row, options)` instead. */ navigateTo(row: number, column?: Keys, activate?: boolean): Promise; /** * Returns a {@link IgxGridLiteColumnConfiguration} for a given column. */ getColumn(id: Keys | number): IgxGridLiteColumnConfiguration | undefined; protected onSorted(_event: CustomEvent>): void; protected onFiltered(_event: CustomEvent>): void; static ɵfac: i0.ɵɵFactoryDeclaration, never>; static ɵcmp: i0.ɵɵComponentDeclaration, "igx-grid-lite", never, { "data": { "alias": "data"; "required": false; "isSignal": true; }; "autoGenerate": { "alias": "autoGenerate"; "required": false; "isSignal": true; }; "sortingOptions": { "alias": "sortingOptions"; "required": false; "isSignal": true; }; "dataPipelineConfiguration": { "alias": "dataPipelineConfiguration"; "required": false; "isSignal": true; }; "sortingExpressions": { "alias": "sortingExpressions"; "required": false; "isSignal": true; }; "filteringExpressions": { "alias": "filteringExpressions"; "required": false; "isSignal": true; }; }, { "sortingExpressions": "sortingExpressionsChange"; "filteringExpressions": "filteringExpressionsChange"; }, never, ["*"], true, never>; } declare global { interface HTMLElementTagNameMap {} interface HTMLElementEventMap { 'sorting': CustomEvent>; 'sorted': CustomEvent>; 'filtering': CustomEvent>; 'filtered': CustomEvent>; } }