DataGrid API

203 of 203 APIs

• BrowserExcelExportAdapterClass

  Built-in dependency-free Excel adapter that creates a browser-generated workbook.

• CellCtxInterface

  CellCtx interface exported by the ngbootstrap package API.

• ColumnDefInterface

  Column metadata for the grid, including sorting, filtering, editing, sticky, locked, width, and validation settings.

• ColumnTypeType

  ColumnType type exported by the ngbootstrap package API.

• DatagridComponent

  Datagrid component exported by the ngbootstrap package API.

  Inputs (94)Outputs (21)Methods (305)
• DATAGRID_COLUMN_DIRECTIVESConstant

  DATAGRID_COLUMN_DIRECTIVES constant exported by the ngbootstrap package API.

• DATAGRID_TEMPLATE_DIRECTIVESConstant

  DATAGRID_TEMPLATE_DIRECTIVES constant exported by the ngbootstrap package API.

• EditCtxInterface

  EditCtx interface exported by the ngbootstrap package API.

• ExcelExportAdapterClass

  Adapter contracts that power PDF and Excel export.

• ExcelExportPayloadInterface

  ExcelExportPayload interface exported by the ngbootstrap package API.

• ExportButtonContextInterface

  ExportButtonContext interface exported by the ngbootstrap package API.

• ExportButtonDirectiveDirective

  ExportButtonDirective directive exported by the ngbootstrap package API.
• FilterCtxInterface

  FilterCtx interface exported by the ngbootstrap package API.

• GlobalFilterCtxInterface

  GlobalFilterCtx interface exported by the ngbootstrap package API.

• GroupColumnCtxInterface

  GroupColumnCtx interface exported by the ngbootstrap package API.

• GroupHeaderCtxInterface

  GroupHeaderCtx interface exported by the ngbootstrap package API.

• HighlightItemInterface

  HighlightItem interface exported by the ngbootstrap package API.

• JsPdfAdapterClass

  Built-in dependency-free PDF adapter that creates a simple browser-generated table PDF.

• NGB_BOOLEAN_FILTER_OPERATORSConstant

  NGB_BOOLEAN_FILTER_OPERATORS constant exported by the ngbootstrap package API.

• NGB_DATAGRID_DEFAULT_LABELSConstant

  NGB_DATAGRID_DEFAULT_LABELS constant exported by the ngbootstrap package API.

• NGB_DATAGRID_DEFAULT_PAGEABLEConstant

  NGB_DATAGRID_DEFAULT_PAGEABLE constant exported by the ngbootstrap package API.

• NGB_DATAGRID_HOSTConstant

  NGB_DATAGRID_HOST constant exported by the ngbootstrap package API.

• NGB_DATAGRID_KEYBOARD_SHORTCUTSConstant

  NGB_DATAGRID_KEYBOARD_SHORTCUTS constant exported by the ngbootstrap package API.

• NGB_DATAGRID_PAGER_BREAKPOINTSConstant

  NGB_DATAGRID_PAGER_BREAKPOINTS constant exported by the ngbootstrap package API.

• NGB_DATAGRID_THEME_OPTIONSConstant

  NGB_DATAGRID_THEME_OPTIONS constant exported by the ngbootstrap package API.

• NGB_DATE_FILTER_OPERATORSConstant

  NGB_DATE_FILTER_OPERATORS constant exported by the ngbootstrap package API.

• NGB_GRID_PASTE_BYTE_LIMITConstant

  NGB_GRID_PASTE_BYTE_LIMIT constant exported by the ngbootstrap package API.

• NGB_GRID_PASTE_CELL_LIMITConstant

  NGB_GRID_PASTE_CELL_LIMIT constant exported by the ngbootstrap package API.

• NGB_NUMERIC_FILTER_OPERATORSConstant

  NGB_NUMERIC_FILTER_OPERATORS constant exported by the ngbootstrap package API.

• NGB_SELECT_FILTER_OPERATORSConstant

  NGB_SELECT_FILTER_OPERATORS constant exported by the ngbootstrap package API.

• NGB_TEXT_FILTER_OPERATORSConstant

  NGB_TEXT_FILTER_OPERATORS constant exported by the ngbootstrap package API.

• NgbAdvancedSearchComponentComponent

  Reusable advanced search builder that emits DataGrid filter descriptors.

  Inputs (16)Outputs (3)Methods (11)
• NgbAdvancedSearchFieldInterface

  Reusable advanced search field and rule configuration.

• NgbAdvancedSearchOperatorInterface

  NgbAdvancedSearchOperator interface exported by the ngbootstrap package API.

• NgbAdvancedSearchRuleInterface

  NgbAdvancedSearchRule interface exported by the ngbootstrap package API.

• ngbAggregateValuesFunction

  ngbAggregateValues function exported by the ngbootstrap package API.

• ngbAllowedFilterOperatorsFunction

  ngbAllowedFilterOperators function exported by the ngbootstrap package API.

• ngbApplyDataGridOperationsFunction

  Processes local arrays with filtering, global search, sorting, paging, and aggregates.

• ngbBuildChartJsConfigFunction

  ngbBuildChartJsConfig function exported by the ngbootstrap package API.

• ngbBuildColumnSelectionChartDataFunction

  ngbBuildColumnSelectionChartData function exported by the ngbootstrap package API.

• ngbBuildFullGridChartDataFunction

  ngbBuildFullGridChartData function exported by the ngbootstrap package API.

• ngbBuildRowSelectionChartDataFunction

  ngbBuildRowSelectionChartData function exported by the ngbootstrap package API.

• ngbBuildSparklinePointsFunction

  ngbBuildSparklinePoints function exported by the ngbootstrap package API.

• ngbCalculateDataGridAggregatesFunction

  Calculates local aggregate values for configured fields.

• NgbCellTemplateDirective

  NgbCellTemplate directive exported by the ngbootstrap package API.

  Inputs (1)
• ngbChartPaletteFunction

  ngbChartPalette function exported by the ngbootstrap package API.

• ngbCloneGridViewFunction

  ngbCloneGridView function exported by the ngbootstrap package API.

• NgbColKeyType

  NgbColKey type exported by the ngbootstrap package API.

• NgbColumnFilterTypeType

  NgbColumnFilterType type exported by the ngbootstrap package API.

• NgbColumnReorderEventInterface

  NgbColumnReorderEvent interface exported by the ngbootstrap package API.

• NgbColumnReorderOptionsInterface

  Placement when calling Datagrid.reorderColumn.

• NgbColumnSelectionChartOptionsInterface

  NgbColumnSelectionChartOptions interface exported by the ngbootstrap package API.

• ngbColumnTypeToFilterTypeFunction

  ngbColumnTypeToFilterType function exported by the ngbootstrap package API.

• NgbCompositeFilterDescriptorInterface

  Root filter tree with `logic` and nested filter descriptors.

• NgbDataAggregateType

  NgbDataAggregate type exported by the ngbootstrap package API.

• NgbDataChartComponentComponent

  Standalone chart renderer.

  Inputs (3)Methods (1)
• NgbDataChartConfigInterface

  Standalone chart renderer configuration.

• NgbDataChartSeriesInterface

  NgbDataChartSeries interface exported by the ngbootstrap package API.

• NgbDataChartTypeType

  NgbDataChartType type exported by the ngbootstrap package API.

• NgbDataDimensionDefInterface

  NgbDataDimensionDef interface exported by the ngbootstrap package API.

• NgbDataGridAggregateDescriptorInterface

  Aggregate field and function descriptor for count, sum, avg, average, min, or max.

• NgbDataGridAggregateFunctionType

  NgbDataGridAggregateFunction type exported by the ngbootstrap package API.

• NgbDataGridAggregateResultsType

  NgbDataGridAggregateResults type exported by the ngbootstrap package API.

• NgbDataGridAggregateTypeType

  Supported aggregate names used by descriptors and grouped aggregate results.

• NgbDatagridButtonDirectiveDirective

  NgbDatagridButtonDirective directive exported by the ngbootstrap package API.

  Inputs (1)
• NgbDatagridButtonVariantType

  NgbDatagridButtonVariant type exported by the ngbootstrap package API.

• NgbDatagridColumnChooserToolComponentComponent

  NgbDatagridColumnChooserToolComponent component exported by the ngbootstrap package API.

  Inputs (2)Methods (7)
• NgbDataGridColumnViewInterface

  NgbDataGridColumnView interface exported by the ngbootstrap package API.

• NgbDatagridControlDirectiveDirective

  NgbDatagridControlDirective directive exported by the ngbootstrap package API.

  Inputs (1)
• NgbDataGridDataResultInterface

  Processed rows plus total count, optional grouped data, and aggregate results.

• NgbDatagridDefaultEditServiceClass

  Default immutable edit service that tracks original rows and removes unsaved new rows on cancel.

• NgbDataGridDetailChangeInterface

  Notification after a current-page detail row changes its expansion state.

• NgbDataGridDetailKeyType

  Stable, unique record identity for optional key-based detail expansion.

• NgbDataGridDetailKeySelectorType

  NgbDataGridDetailKeySelector type exported by the ngbootstrap package API.

• NgbDataGridDetailPredicateType

  Pure predicate deciding whether a row offers a detail disclosure.

• NgbDatagridEditServiceInterface

  Edit workflow contract used by the grid for create, update, delete, save, and cancel handling.

• NgbDataGridExportOptionsInterface

  Export configuration for PDF/Excel, page source, file names, and adapter-specific options.

• NgbDataGridExportPagesType

  NgbDataGridExportPages type exported by the ngbootstrap package API.

• NgbDataGridExportTypeType

  NgbDataGridExportType type exported by the ngbootstrap package API.

• NgbDatagridFieldShellComponentComponent

  NgbDatagridFieldShellComponent component exported by the ngbootstrap package API.

  Inputs (1)
• NgbDatagridFilterToolComponentComponent

  NgbDatagridFilterToolComponent component exported by the ngbootstrap package API.

  Inputs (2)Methods (9)
• NgbDatagridFloatingPanelDirectiveDirective

  Popup-style overlay: anchors to a trigger, portals to document.body, and uses viewport-fixed coordinates.

  Inputs (2)Methods (1)
• NgbDatagridFloatingPanelPlacementType

  NgbDatagridFloatingPanelPlacement type exported by the ngbootstrap package API.

• NgbDataGridGroupChangeInterface

  Event payload emitted by `(groupChange)` with the active descriptor list.

• NgbDataGridGroupDescriptorInterface

  Grouped field descriptor with `field`, optional ascending/descending `dir`, and optional per-group `aggregates`.

• NgbDataGridGroupFooterTemplateDirectiveDirective

  NgbDataGridGroupFooterTemplateDirective directive exported by the ngbootstrap package API.

  Inputs (2)
• NgbDataGridGroupHeaderColumnTemplateDirectiveDirective

  NgbDataGridGroupHeaderColumnTemplateDirective directive exported by the ngbootstrap package API.

  Inputs (2)
• NgbDataGridGroupHeaderTemplateDirectiveDirective

  NgbDataGridGroupHeaderTemplateDirective directive exported by the ngbootstrap package API.
• NgbDataGridGroupingSettingsInterface

  Grouping configuration with standard/compact `displayMode`, optional `showGroupButton`, `showFooter`, `stickyHeaders`, and `stickyFooters`.

• NgbDataGridGroupResultInterface

  Nested local or provided grouping result with field, value, level, count, optional aggregate results, and child items.

• NgbDataGridHistoryDirectiveDirective

  Opt-in history for configuration changes and saved edits to existing rows.

  Inputs (2)Outputs (1)Methods (7)
• NgbDataGridHistoryResultType

  NgbDataGridHistoryResult type exported by the ngbootstrap package API.

• NgbDatagridLabelsInterface

  Localizable strings for built-in datagrid UI (pagination, filters, actions, a11y).

• NgbDatagridLayoutToolbarComponentComponent

  NgbDatagridLayoutToolbarComponent component exported by the ngbootstrap package API.

  Inputs (2)
• NgbDatagridLayoutToolbarSpacerComponentComponent

  NgbDatagridLayoutToolbarSpacerComponent component exported by the ngbootstrap package API.
• NgbDatagridPageableSettingsInterface

  Pager configuration for Datagrid via `[pageable]`.

• NgbDatagridPagerDensityType

  NgbDatagridPagerDensity type exported by the ngbootstrap package API.

• NgbDatagridPagerPositionType

  NgbDatagridPagerPosition type exported by the ngbootstrap package API.

• ngbDatagridPagerSettingsFunction

  Settings for NgbPagerComponent (excludes grid-only `position`).

• NgbDatagridPagerTypeType

  NgbDatagridPagerType type exported by the ngbootstrap package API.

• NgbDataGridProcessOptionsInterface

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

• NgbDataGridResponsiveOptionsInterface

  Responsive mode settings. The current implementation only checks `enabled`.

• NgbDatagridRowIdType

  NgbDatagridRowId type exported by the ngbootstrap package API.

• NgbDataGridSavedViewInterface

  NgbDataGridSavedView interface exported by the ngbootstrap package API.

• NgbDataGridScrollItemRequestInterface

  NgbDataGridScrollItemRequest interface exported by the ngbootstrap package API.

• NgbDataGridScrollModeType

  NgbDataGridScrollMode type exported by the ngbootstrap package API.

• NgbDataGridScrollRequestInterface

  NgbDataGridScrollRequest interface exported by the ngbootstrap package API.

• NgbDataGridSortDescriptorInterface

  NgbDataGridSortDescriptor interface exported by the ngbootstrap package API.

• NgbDataGridSortDirectionType

  NgbDataGridSortDirection type exported by the ngbootstrap package API.

• NgbDatagridSortToolComponentComponent

  NgbDatagridSortToolComponent component exported by the ngbootstrap package API.

  Inputs (2)Methods (5)
• NgbDataGridStateInterface

  Unified data-operation state with page, page index, skip, page size, sort, group, filter, and global filter.

• NgbDatagridSurfaceCardComponentComponent

  NgbDatagridSurfaceCardComponent component exported by the ngbootstrap package API.
• NgbDatagridTextDirectionType

  NgbDatagridTextDirection type exported by the ngbootstrap package API.

• NgbDataGridThemeType

  Grid-scoped theme token name used by the DataGrid and theme picker.

• NgbDataGridThemeOptionInterface

  NgbDataGridThemeOption interface exported by the ngbootstrap package API.

• NgbDatagridThemePickerComponentComponent

  Grid theme picker that emits NgbDataGridTheme values.

  Inputs (3)Outputs (1)Methods (4)
• NgbDatagridToolbarComponentComponent

  NgbDatagridToolbarComponent component exported by the ngbootstrap package API.

  Inputs (3)
• NgbDatagridTrackByFnType

  Track-by callback that returns a stable row identifier value.

• NgbDataGridViewRestoreResultType

  NgbDataGridViewRestoreResult type exported by the ngbootstrap package API.

• NgbDataGridViewsComponentComponent

  Explicit, application-owned persistence; grid changes are never saved automatically.

  Inputs (3)Methods (8)
• NgbDataGridViewSnapshotInterface

  NgbDataGridViewSnapshot interface exported by the ngbootstrap package API.

• NgbDataGridViewStoreInterface

  NgbDataGridViewStore interface exported by the ngbootstrap package API.

• NgbDataGridVirtualRangeInterface

  Requested remote range; the application owns fetching, cancellation and caching.

• NgbDataLayoutModeType

  Tabular columns vs adaptive stacked cards (`stacked` in NgbTableOptions).

• NgbDataMetricDefInterface

  NgbDataMetricDef interface exported by the ngbootstrap package API.

• NgbDataSparklineComponentComponent

  Inline sparkline renderer for cells or standalone layouts.

  Inputs (11)
• ngbDefaultFilterOperatorFunction

  ngbDefaultFilterOperator function exported by the ngbootstrap package API.

• ngbDeserializeGridViewFunction

  ngbDeserializeGridView function exported by the ngbootstrap package API.

• NgbDndDropEventInterface

  NgbDndDropEvent interface exported by the ngbootstrap package API.

• NgbEditModeType

  Built-in row editing interaction mode.

• NgbEditorTemplateDirective

  NgbEditorTemplate directive exported by the ngbootstrap package API.

  Inputs (1)
• NgbExportServiceClass

  Delegates export calls to an injected PDF or Excel adapter.

• NgbFilterableType

  Filtering mode input type: `boolean`, `row`, `menu`, `multi`, or `none`.

• NgbFilterDescriptorInterface

  Single filter rule with `field`, `operator`, optional `value`, and `ignoreCase`.

• NgbFilterMenuTemplateDirective

  NgbFilterMenuTemplate directive exported by the ngbootstrap package API.

  Inputs (1)
• NgbFilterModeType

  NgbFilterMode type exported by the ngbootstrap package API.

• NgbFilterOperatorType

  Supported operators such as `contains`, `eq`, `gt`, `isnull`, and `isempty`.

• ngbFilterOperatorLabelFunction

  ngbFilterOperatorLabel function exported by the ngbootstrap package API.

• NgbFilterStateInterface

  Convenience state shape with `global` plus a descriptor root.

• NgbFilterTemplateDirective

  NgbFilterTemplate directive exported by the ngbootstrap package API.

  Inputs (1)
• ngbFindFieldFilterDescriptorFunction

  Returns the first leaf descriptor for `field`, searching nested composite nodes.

• ngbFlattenFilterDescriptorsFunction

  Recursively collects leaf filter descriptors from a composite filter tree.

• ngbFormatDatagridLabelFunction

  ngbFormatDatagridLabel function exported by the ngbootstrap package API.

• NgbFullGridChartOptionsInterface

  NgbFullGridChartOptions interface exported by the ngbootstrap package API.

• NgbGlobalFilterTemplateDirective

  NgbGlobalFilterTemplate directive exported by the ngbootstrap package API.
• NgbGridBatchApplyToolDirectiveDirective

  Native button with application-owned label; disabled while validation is pending.

  Outputs (1)Methods (1)
• NgbGridBatchCellErrorInterface

  Validator receives proposed changes and AbortSignal, returning cell errors or a Promise. Errors contain rowId, field and message.

• NgbGridBatchControllerInterface

  Internal bridge between the host grid and its opt-in batch directive.

• NgbGridBatchDiscardToolDirectiveDirective

  Discard remains available during async validation and cancels stale completion.

  Methods (1)
• NgbGridBatchEditingDirectiveDirective

  Draft-only clipboard editing. Apply commits once; application code owns persistence.

  Inputs (1)Outputs (1)Methods (12)
• NgbGridBatchResultType

  Discriminated success/failure results: changedCells or copied text on success; reason and message on failure.

• NgbGridBatchRowChangeInterface

  A change contains rowId, original and updated. A save contains changes plus optional undo/redo historyAction.

• NgbGridBatchSaveEventInterface

  A change contains rowId, original and updated. A save contains changes plus optional undo/redo historyAction.

• NgbGridBatchValidatorType

  Validator receives proposed changes and AbortSignal, returning cell errors or a Promise. Errors contain rowId, field and message.

• NgbGridCellAddressInterface

  Stable rowId and field addresses; a range contains anchor and focus.

• NgbGridCellRangeInterface

  Stable rowId and field addresses; a range contains anchor and focus.

• NgbGridChartComponentComponent

  Composite grid and Chart.js-backed chart widget.

  Inputs (2)Outputs (1)Methods (5)
• NgbGridChartConfigInterface

  Configuration for the Grid to Chart composite widget.

• NgbGridChartModeType

  NgbGridChartMode type exported by the ngbootstrap package API.

• NgbGridChartSelectionChangeInterface

  NgbGridChartSelectionChange interface exported by the ngbootstrap package API.

• NgbGridChartSparklineOptionsInterface

  NgbGridChartSparklineOptions interface exported by the ngbootstrap package API.

• ngbGridClipboardByteLengthFunction

  ngbGridClipboardByteLength function exported by the ngbootstrap package API.

• NgbGridClipboardResultType

  Discriminated success/failure results: changedCells or copied text on success; reason and message on failure.

• NgbGridColumnDirectiveDirective

  NgbGridColumnDirective directive exported by the ngbootstrap package API.

  Inputs (27)Methods (1)
• NgbGridHighlightDirectiveDirective

  NgbGridHighlightDirective directive exported by the ngbootstrap package API.

  Inputs (3)
• NgbGridRedoToolDirectiveDirective

  Native button with application-owned text, icons, classes and accessible label.

  Inputs (1)Outputs (1)Methods (1)
• NgbGridUndoToolDirectiveDirective

  Native button with application-owned text, icons, classes and accessible label.

  Inputs (1)Outputs (1)Methods (1)
• ngbGroupDataFunction

  Groups local arrays by one or more field descriptors and returns nested group metadata.

• ngbIsCompositeFilterFunction

  ngbIsCompositeFilter function exported by the ngbootstrap package API.

• NgbLocalStorageGridViewStoreClass

  Opt-in persistence. Storage is resolved lazily, never during import or SSR.

• NgbMemoryGridViewStoreClass

  NgbMemoryGridViewStore class exported by the ngbootstrap package API.

• NgbMenuFilterConditionDraftInterface

  Single condition in a column filter menu or layout-toolbar filter tool.

• NgbMultiCheckboxFilterOptionsInterface

  NgbMultiCheckboxFilterOptions interface exported by the ngbootstrap package API.

• ngbOperatorRequiresFilterValueFunction

  ngbOperatorRequiresFilterValue function exported by the ngbootstrap package API.

• NgbPagerDensityType

  Responsive pager density based on container width. - `full`: info, pagination, and page-size controls - `compact`: hides range info - `minimal`: hides range info and page-size controls (pagination remains)

• NgbPagerSettingsInterface

  Configuration for NgbPagerComponent.

• NgbPagerTemplateDirective

  NgbPagerTemplate directive exported by the ngbootstrap package API.
• NgbPagerTypeType

  NgbPagerType type exported by the ngbootstrap package API.

• ngbParseGridClipboardFunction

  TSV with CSV-style quoting; rejects ragged or malformed matrices.

• ngbResolveDatagridPagerSettingsFunction

  ngbResolveDatagridPagerSettings function exported by the ngbootstrap package API.

• ngbResolvePageableSettingsFunction

  ngbResolvePageableSettings function exported by the ngbootstrap package API.

• NgbRowDetailTemplateDirective

  NgbRowDetailTemplate directive exported by the ngbootstrap package API.
• NgbRowKeyType

  NgbRowKey type exported by the ngbootstrap package API.

• NgbRowSelectionChartOptionsInterface

  NgbRowSelectionChartOptions interface exported by the ngbootstrap package API.

• NgbSearchHighlightComponentComponent

  Reusable search-highlight controls for DataGrid or any external list/grid.

  Inputs (9)Outputs (3)Methods (3)
• NgbSearchHighlightFieldInterface

  Field metadata for the search highlight widget.

• NgbSearchHighlightSegmentInterface

  Labels and visibility for the built-in multi-checkbox filter menu footer. Segment returned by Datagrid.getSearchHighlightSegments for match highlighting.

• NgbSearchHighlightSelectionChangeInterface

  NgbSearchHighlightSelectionChange interface exported by the ngbootstrap package API.

• NgbSelectionBehaviorType

  NgbSelectionBehavior type exported by the ngbootstrap package API.

• NgbSelectionKeyModeType

  NgbSelectionKeyMode type exported by the ngbootstrap package API.

• NgbSelectionLabelsInterface

  Optional accessible labels for select-all and per-row selection controls.

• NgbSelectionModeType

  Selection configuration types used by the row selection API.

• ngbSerializeGridClipboardFunction

  ngbSerializeGridClipboard function exported by the ngbootstrap package API.

• ngbSerializeGridViewFunction

  ngbSerializeGridView function exported by the ngbootstrap package API.

• ngbSetFieldFilterFunction

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

• NgbSparklinePointInterface

  NgbSparklinePoint interface exported by the ngbootstrap package API.

• NgbTableOptionsInterface

  Bootstrap table presentation options plus caption, responsive wrapper, and sticky flags.

• NgbTableResponsiveType

  NgbTableResponsive type exported by the ngbootstrap package API.

• ngbValidateGridViewFunction

  ngbValidateGridView function exported by the ngbootstrap package API.

• PagerCtxInterface

  PagerCtx interface exported by the ngbootstrap package API.

• PdfExportAdapterClass

  Adapter contracts that power PDF and Excel export.

• PdfExportOptionsInterface

  PdfExportOptions interface exported by the ngbootstrap package API.

• PdfExportPayloadInterface

  PdfExportPayload interface exported by the ngbootstrap package API.

Signatures come from the installed public package. Usage guides explain workflows; this index is the reference for exported names and contracts.