Vue Data GridOverlay Component

ReactAngularVueJavascript

Overlay components allow you to add your own overlays to AG Grid. Use these when the provided overlays do not meet your requirements.

There are two types of overlay components:

• Loading Overlay: Overlay for when the grid is loading data.
• No Rows: Overlay for when the grid has loaded an empty array of rows.

Example: Custom Overlay Components

The example below demonstrates how to provide custom overlay components to the grid. Notice the following:

• Custom Loading Overlay Renderer is supplied by name via gridOptions.loadingOverlayComponent.
• Custom Loading Overlay Renderer Parameters are supplied using gridOptions loadingOverlayComponentParams.
• Custom No Rows Overlay Renderer is supplied by name via gridOptions.noRowsOverlayComponent.
• Custom No Rows Overlay Renderer Parameters are supplied using gridOptions.noRowsOverlayComponentParams.

Implementing a Loading Overlay Component

Any valid Vue component can be a loading overlay component, however it is also possible to implement the following optional methods:

interface ILoadingOverlay {
    // Gets called when the `loadingOverlayComponentParams` grid option is updated
    refresh(params: ILoadingOverlayParams): void;
}

When a custom loading overlay is instantiated, the following will be made available on this.params:

Implementing a No Rows Overlay Component

Any valid Vue component can be a no rows overlay component, however it is also possible to implement the following optional methods:

interface INoRowsOverlay {
    // Gets called when the `noRowsOverlayComponentParams` grid option is updated
    refresh(params: INoRowsOverlayParams): void;
}

When a custom no rows overlay is instantiated, the following will be made available on this.params:

Registering Overlay Components

See Registering Custom Components for details on registering and using custom overlays.