API Reference

Complete API documentation for @gp-grid/angular.

Grid Props

All inputs accepted by the Grid component

Column Definition

Configure individual columns

Data Sources

Client-side and server-side data handling

The Angular reference is still being fleshed out. The shape of GridProps and ColumnDefinition matches the other bindings — see the React API Reference for anything not yet documented here.

Exports

// Component
import { GpGridComponent } from "@gp-grid/angular";

// Types
import type {
  AngularColumnDefinition,
  CellRendererTemplate,
  EditRendererTemplate,
  HeaderRendererTemplate,
  ColumnDefinition,
  CellDataType,
  CellValue,
  CellPosition,
  CellRange,
  SortDirection,
  SortModel,
  FilterModel,
  DataSource,
  DataSourceRequest,
  DataSourceResponse,
  MutableDataSource,
  CellRendererParams,
  EditRendererParams,
  HeaderRendererParams,
  HighlightingOptions,
} from "@gp-grid/angular";

// Data source factories
import {
  createClientDataSource,
  createDataSourceFromArray,
  createMutableClientDataSource,
  createServerDataSource,
} from "@gp-grid/angular";

// Grid data helpers
import {
  provideGridData,   // component providers for DI-based data
  injectGridData,    // typed inject() helper
  GridDataService,   // the underlying service
  createGridData,    // function-based alternative (no DI)
} from "@gp-grid/angular";

// Data options / API types
import type {
  GridDataOptions,
  GridDataApi,
} from "@gp-grid/angular";