@adaptabletools/adaptable
Version:
Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
48 lines (47 loc) • 2.45 kB
TypeScript
import { ApiBase } from './ApiBase';
import { DashboardApi } from '../DashboardApi';
import { DashboardState, DashboardTab } from '../../AdaptableState/DashboardState';
import { AdaptableDashboardToolbar, AdaptableDashboardToolbars, AdaptableModuleButtons } from '../../AdaptableState/Common/Types';
import { AdaptableButton } from '../../AdaptableState/Common/AdaptableButton';
import { CustomToolbar, DashboardButtonContext } from '../../types';
import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
import { DashboardInternalApi } from '../Internal/DashboardInternalApi';
export declare class DashboardApiImpl extends ApiBase implements DashboardApi {
internalApi: DashboardInternalApi;
constructor(_adaptable: IAdaptable);
getDashboardState(): DashboardState;
getCustomToolbars(): CustomToolbar[];
getCustomDashboardButtons(): AdaptableButton<DashboardButtonContext>[];
getCustomDashboardButtonByLabel(buttonLabel: string): AdaptableButton<DashboardButtonContext> | undefined;
setModuleButtons(moduleButtons: AdaptableModuleButtons): void;
setDashboardTitle(title: string): void;
getCustomToolbarHTMLElement(customToolbarName: string): HTMLElement | null;
setCustomToolbarHTMLContent(customToolbarName: string, htmlContent: string): void;
getCustomToolbarByName(customToolbarName: string): CustomToolbar;
getTabByName(tabName: string): DashboardTab;
collapseDashboard(): void;
expandDashboard(): void;
refreshDashboard(): void;
floatDashboard(): void;
dockDashboard(): void;
hideDashboard(): void;
showDashboard(): void;
getActiveTabIndex(): number | undefined;
getActiveTab(): DashboardTab | undefined;
setTabs(Tabs: DashboardTab[]): void;
getTabs(): DashboardTab[];
getModuleButtons(): AdaptableModuleButtons;
setPinnedToolbars(toolbars: AdaptableDashboardToolbars | string[]): void;
getPinnedToolbars(): AdaptableDashboardToolbars | string[];
isToolbarVisible(toolbar: AdaptableDashboardToolbar | string): boolean;
setActiveTabIndex(tabIndex: number): void;
setActiveTab(tabName: string): void;
getCurrentToolbars(): AdaptableDashboardToolbars | string[];
openDashboardSettingsPanel(): void;
isDashboardCollapsed(): boolean;
isDashboardExpanded(): boolean;
isDashboardFloating(): boolean;
isDashboardDocked(): boolean;
isDashboardHidden(): boolean;
isDashboardVisible(): boolean;
}