← DataGrid API

Interface · v2.7.1

FilterCtx

FilterCtx interface exported by the ngbootstrap package API.

Import

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

Declaration

interface FilterCtx<T = any>

Properties

$implicit

$implicit: AbstractControl | null

control

control: AbstractControl | null

col

col: ColumnDef<T>

field

Column field name (same as `col.field`).

field: string

descriptor

descriptor: NgbFilterDescriptor | null

filter

Current composite filter root (clone). Use with `filterChange` for custom filter templates.

operators

operators: NgbFilterOperator[]

setOperator

setOperator: (operator: NgbFilterOperator) => void

setValue

setValue: (value: any) => void

clear

clear: () => void

filterChange

Replaces the grid filter state and emits `filterChange` when enabled.

filterChange: (filter: NgbCompositeFilterDescriptor) => void

setFieldFilter

Sets this column's field filter in the current descriptor and commits.

setFieldFilter: (operator: NgbFilterOperator, value?: any) => void

Referenced types

Source: src/datagrid/src/directives/datagrid-templates.directive.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.