Angular Data GridActive Overlay

Version 36.2.0

Applications can display an overlay on demand regardless of grid state. This is achieved by providing an active overlay which can be one of the provided overlays or be a custom overlay component.

app.component.ts

import { Component, signal } from "@angular/core";

import { AgGridAngular } from "ag-grid-angular";
import {
  ClientSideRowModelModule,
  ModuleRegistry,
  enableDevValidations,
} from "ag-grid-community";
import type { ColDef, GridApi, GridReadyEvent } from "ag-grid-community";

import { CustomOverlayComponent } from "./custom-overlay.component";
import "./styles.css";

if (process.env.NODE_ENV !== "production") {
  // Enable extended validations only for development
  enableDevValidations();
}

ModuleRegistry.registerModules([ClientSideRowModelModule]);

interface IAthlete {
  athlete: string;
  country: string;
}

@Component({
  selector: "my-app",
  standalone: true,
  imports: [AgGridAngular],
  template: `<div class="example-wrapper">
    <div class="button-row">
      <button (click)="showActiveOverlay()">Show custom overlay</button>
      <button (click)="clearActiveOverlay()">Hide custom overlay</button>
      <button (click)="incParam()">Increment Param</button>
    </div>
    <ag-grid-angular
      style="width: 100%; height: 100%;"
      class="grid-wrapper"
      [columnDefs]="columnDefs"
      [rowData]="rowData"
      [activeOverlay]="activeOverlay()"
      [activeOverlayParams]="activeOverlayParams()"
    />
  </div>`,
})
export class AppComponent {
  columnDefs: ColDef[] = [
    { field: "athlete", flex: 1 },
    { field: "country", flex: 1 },
  ];
  rowData: IAthlete[] | null = [
    { athlete: "Michael Phelps", country: "United States" },
    { athlete: "Natalie Coughlin", country: "United States" },
    { athlete: "Aleksey Nemov", country: "Russia" },
    { athlete: "Alicia Coutts", country: "Australia" },
  ];

  activeOverlay = signal<any>(CustomOverlayComponent);
  activeOverlayParams = signal({ count: 1 });

  showActiveOverlay() {
    this.activeOverlay.set(CustomOverlayComponent);
  }

  clearActiveOverlay() {
    this.activeOverlay.set(undefined);
  }
  incParam() {
    this.activeOverlayParams.update((prev) => ({ count: prev.count + 1 }));
  }
}

styles.css

.example-wrapper {
    display: flex;
    flex-direction: column;
    height: 100%;
}

.button-row {
    display: flex;
    flex-wrap: wrap;
    gap: 12px;
    padding: 12px;
}

.button-row button {
    padding: 4px 12px;
}

.grid-wrapper {
    flex: 1 1 0;
    min-height: 0;
}

.my-custom-overlay {
    padding: 16px;
    font-size: 32px;
    background: rgba(0, 0, 0, 0.1);
    border-radius: 20px;
}

custom-overlay.component.ts

import { Component, signal } from "@angular/core";

import type { IOverlayAngularComp } from "ag-grid-angular";
import type { IOverlayParams } from "ag-grid-community";

export interface CustomParams {
  count: number;
}

@Component({
  selector: "app-custom-overlay",
  standalone: true,
  template: `<div class="my-custom-overlay">
    Custom Overlay: {{ count() }}
  </div>`,
})
export class CustomOverlayComponent implements IOverlayAngularComp {
  count = signal(0);

  agInit(params: IOverlayParams & CustomParams): void {
    this.refresh(params);
  }

  refresh(params: IOverlayParams & CustomParams) {
    this.count.set(params.count);
  }
}

main.ts

import '@angular/compiler';
import { provideHttpClient } from '@angular/common/http';
import { enableProdMode } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';

import { AppComponent } from './app.component';

if (new URLSearchParams(window.location.search).get('prod') !== 'false') {
    enableProdMode();
}

const app = bootstrapApplication(AppComponent, {
    providers: [provideHttpClient()],
});

Display an Active Overlay Copy Link

To display an overlay on demand set the activeOverlay / activeOverlayParams grid option. To clear the overlay set activeOverlay = undefined.

any

Display an overlay on demand. If provided takes precedence over the grid provided overlays.

name of a provided overlay, i.e agLoadingOverlay, agNoRowsOverlay, agNoMatchingRowsOverlay, agExportingOverlay

component class/function.

key of a custom component registered in the components map.

undefined to clear.

any

Custom parameters to be supplied to the activeOverlay component in addition to IOverlayParams. Updating the params will trigger a refresh of the active overlay.

Implement the IOverlayComp interface to provide a custom overlay the grid will supply IOverlayParams whenever the component is created or refreshed.


interface IOverlayAngularComp {
  // Mandatory - Params for rendering this component. 
  agInit(params: IOverlayParams): void;

  // Gets called when the `overlayComponentParams` grid option is updated
  refresh?(params: TParams): void;

}

The example below demonstrates using the grid provided overlays as an active overlay. Note the following:

activeOverlays take precedence over the provided loading overlay.
activeOverlay can be displayed no matter what the grid state, i.e showing the no-rows overlay even when there are rows.
StatusOverlay is registered in the components map and shown by setting activateOverlay = "statusOverlay" to the key used.

app.component.ts

import { Component, computed, model, signal } from "@angular/core";
import { FormsModule } from "@angular/forms";

import { AgGridAngular } from "ag-grid-angular";
import type { IOverlayAngularComp } from "ag-grid-angular";
import type { ColDef } from "ag-grid-community";
import {
  ClientSideRowModelModule,
  ModuleRegistry,
  enableDevValidations,
} from "ag-grid-community";
import type { IOverlayParams } from "ag-grid-community";

import "./styles.css";

if (process.env.NODE_ENV !== "production") {
  // Enable extended validations only for development
  enableDevValidations();
}

ModuleRegistry.registerModules([ClientSideRowModelModule]);

@Component({
  standalone: true,
  template: `<div class="status-overlay">Custom</div>`,
})
export class StatusOverlayComponent implements IOverlayAngularComp {
  agInit(params: IOverlayParams): void {
    console.log("init");
  }
}

interface Athlete {
  athlete: string;
  country: string;
}

@Component({
  selector: "my-app",
  standalone: true,
  imports: [AgGridAngular, FormsModule],
  template: `<div class="example-wrapper">
    <div class="button-row">
      <label class="toggle loading-toggle"
        ><input
          type="checkbox"
          [checked]="loadingToggle()"
          (change)="loadingToggle.set(!loadingToggle())"
        />
        Loading</label
      >
      <button type="button" (click)="showNoRowsOverlay()">
        activeOverlay = agNoRowsOverlay
      </button>
      <button type="button" (click)="showCustomOverlay()">
        activeOverlay = CustomOverlay
      </button>
      <button type="button" (click)="clearOverlay()">Hide activeOverlay</button>
    </div>
    <div class="grid-wrapper">
      <ag-grid-angular
        style="width: 100%; height: 100%;"
        [columnDefs]="columnDefs"
        [rowData]="rowData"
        [components]="components"
        [loading]="loading()"
        [activeOverlay]="activeOverlay()"
      />
    </div>
  </div>`,
})
export class AppComponent {
  public readonly columnDefs: ColDef<Athlete>[] = [
    { field: "athlete", flex: 1 },
    { field: "country", flex: 1 },
  ];

  public readonly rowData: Athlete[] = [
    { athlete: "Michael Phelps", country: "United States" },
    { athlete: "Natalie Coughlin", country: "United States" },
  ];

  public readonly components = { statusOverlay: StatusOverlayComponent };

  public readonly activeOverlay = signal<string | undefined>(undefined);
  public readonly loadingToggle = signal<boolean>(false);
  public readonly loading = computed(() => this.loadingToggle());

  public showNoRowsOverlay(): void {
    this.activeOverlay.set("agNoRowsOverlay");
  }

  public showCustomOverlay(): void {
    this.activeOverlay.set("statusOverlay");
  }

  public clearOverlay(): void {
    this.activeOverlay.set(undefined);
  }
}

styles.css

.example-wrapper {
    display: flex;
    flex-direction: column;
    height: 100%;
}

.button-row {
    display: flex;
    flex-wrap: wrap;
    gap: 12px;
    padding: 12px;
}

.button-row button {
    padding: 4px 12px;
}

.button-row .loading-toggle {
    display: inline-flex;
    align-items: center;
    gap: 6px;
    font-weight: 600;
    user-select: none;
}

.grid-wrapper {
    flex: 1 1 0;
    min-height: 0;
}

.status-overlay {
    padding: 16px;
    border-radius: 16px;
    border: 3px solid pink;
    font-size: 32px;
}

main.ts

import '@angular/compiler';
import { provideHttpClient } from '@angular/common/http';
import { enableProdMode } from '@angular/core';
import { bootstrapApplication } from '@angular/platform-browser';

import { AppComponent } from './app.component';

if (new URLSearchParams(window.location.search).get('prod') !== 'false') {
    enableProdMode();
}

const app = bootstrapApplication(AppComponent, {
    providers: [provideHttpClient()],
});

Getting Started

AI Features

Layout & Styling

Charting

Core Features

Advanced Features

Angular Data GridActive Overlay

Display an Active Overlay Copy Link