@adaptabletools/adaptable/src/Api/Internal/DashboardInternalApi.d.ts

Powerful AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements

import { DashboardState } from '../../AdaptableState/DashboardState';
import { ApiBase } from '../Implementation/ApiBase';
export declare class DashboardInternalApi extends ApiBase {
    /**
     * Registry of reset-callbacks keyed by Custom-Toolbar name. Each
     * `CustomToolbarCmp` registers itself on mount so the public
     * {@link DashboardApi.resetCustomToolbarFormData} method can ask
     * a specific instance to roll its `toolbarForm` data back to its
     * declared `defaultValue`s without re-mounting the component.
     */
    private customToolbarFormResetters;
    /**
     * Register a reset callback for a Custom Toolbar. Idempotent: a second
     * registration for the same name overwrites the previous entry, so a
     * remount of the same toolbar always wins.
     */
    registerCustomToolbarFormResetter(toolbarName: string, resetter: () => void): void;
    /**
     * Tear down a previously-registered reset callback, but only if it's
     * still the active one. Guards against a stale unmount clobbering a
     * registration made by a fresh mount of the same toolbar.
     */
    unregisterCustomToolbarFormResetter(toolbarName: string, resetter: () => void): void;
    /**
     * Invokes the registered reset callback for the given toolbar (or all
     * registered toolbars when `toolbarName` is omitted). Silently no-ops
     * if no toolbar is registered under the given name - this is benign
     * (e.g. the toolbar has not yet mounted, or it has no `toolbarForm`).
     */
    resetCustomToolbarFormData(toolbarName?: string): void;
    isToolbarInActiveTab(toolbarName: string, dashboardState: DashboardState): boolean;
    isToolbarCustom(toolbarName: string): boolean;
    getCustomToolbarRenderContainerId(customToolbarName: string): string;
    getCustomToolbarButtonsContainerId(customToolbarName: string): string;
    getCustomToolbarComponentContainerId(customToolbarName: string): string;
    getModuleToolbars(): {
        id: import("../../AdaptableState/Common/Types").AdaptableDashboardToolbar;
        friendlyName: string;
    }[];
}