← DataGrid API

Interface · v2.6.0

NgbDataGridProcessOptions

Options for local data operations, global filter fields, columns, aggregate descriptors, provided grouped data, and paging.

Import

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

Declaration

interface NgbDataGridProcessOptions<T = unknown>

Properties

state

state?: NgbDataGridState | null

aggregates

groupedData

groupedData?: NgbDataGridGroupResult<T>[] | null

globalFilterFields

globalFilterFields?: string[]

columns

columns?: Array<{ field: Extract<keyof T, string> | string; type?: string; filterType?: string; }>

page

When false, returns the filtered/sorted full result without page slicing. Aggregates are always calculated before page slicing.

page?: boolean

Referenced types

Source: src/datagrid/src/datagrid.types.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.