ag-grid-community/dist/types/src/rendering/overlays/overlayService.d.ts

Advanced Data Grid / Data Table supporting Javascript / Typescript / React / Angular / Vue

import type { NamedBean } from '../../context/bean';
import { BeanStub } from '../../context/beanStub';
import type { ComponentSelector } from '../../widgets/component';
import { OverlayWrapperComponent } from './overlayWrapperComponent';
export declare class OverlayService extends BeanStub implements NamedBean {
    beanName: "overlays";
    eWrapper: OverlayWrapperComponent | undefined;
    exclusive: boolean;
    private oldExclusive;
    private currentDef;
    private showInitialOverlay;
    private userForcedNoRows;
    private exportsInProgress;
    private focusedCell;
    private devErrorOverlayActive;
    private newColumnsLoadedCleanup;
    postConstruct(): void;
    destroy(): void;
    setWrapperComp(overlayWrapperComp: OverlayWrapperComponent, destroyed: boolean): void;
    /** Returns true if the overlay is visible. */
    isVisible(): boolean;
    /**
     * Shows or hides the dev-only validation error overlay. Driven by the ValidationModule's
     * ErrorOverlayService; takes priority over the data-driven overlays while active. Re-evaluates
     * immediately so the overlay appears as soon as the wrapper exists (or once it later mounts).
     */
    setDevErrorOverlay(active: boolean): void;
    showLoadingOverlay(): void;
    showNoRowsOverlay(): void;
    showExportOverlay(heavyOperation: () => void): Promise<void>;
    hideOverlay(): void;
    getOverlayWrapperSelector(): ComponentSelector;
    getOverlayWrapperCompClass(): typeof OverlayWrapperComponent;
    private onPropChange;
    private updateOverlay;
    private getDesiredDefWithOverride;
    private getOverlayDef;
    private disableInitialOverlay;
    /**
     * Show an overlay requested by name or by built-in types.
     * This single function replaces the previous three helpers and handles
     * param selection and wrapper class choice for loading / no-rows and custom overlays.
     */
    private doShowOverlay;
    private makeCompParams;
    private doHideOverlay;
    private setExclusive;
    private isDisabled;
}