← DataGrid API

Function · v2.7.1

ngbSetFieldFilter

Returns a new composite filter with the field set (or removed when value is empty). Supports manual `filterChange(root)` updates from custom filter templates.

Import

import { ngbSetFieldFilter } from '@angular-bootstrap/ngbootstrap';

Declaration

function ngbSetFieldFilter(composite: NgbCompositeFilterDescriptor, field: string, operator: NgbFilterOperator, value?: unknown, options?: { requiresValue?: (operator: NgbFilterOperator) => boolean; }): NgbCompositeFilterDescriptor;

Referenced types

Source: src/datagrid/src/models/filtering.ts in the installed @angular-bootstrap/ngbootstrap package. Angular compiler metadata and private members are omitted.

This project is not affiliated with ng-bootstrap or ngx-bootstrap. Those projects focus mainly on Bootstrap components for Angular. ngbootstrap focuses on Angular UI for data-heavy apps, especially Data Grid, Angular-native Form Builder, drag and drop workflows, documentation examples, and performance-focused Angular patterns.