DashboardApi

declare class DashboardApi extends BaseApi

getAvailableRuntimeBarWidgets(): ("view" | "ribbon" | "row-count" | "application-name" | "theme" | "alert" | "export" | "styledCell" | "quickSearch" | "calculatedColumn" | "settingsPanel" | "dashboard" | "flashingCell" | "cell-summary")[];

getAvailableRuntimeTabsWidgetIds(): ("view" | "column-chooser" | "theme" | "alert" | "export" | "styledCell" | "quickSearch" | "calculatedColumn" | "settingsPanel" | "dashboard" | "flashingCell" | "cell-summary")[];

getCustomWidgets(): DashboardState['customWidgets'];

getDashboardState(): DashboardState;

getRuntimeCustomWidgets(): string[];

getWidgetDefinition(widgetType: WidgetIdType): {
        readonly label: "Noop";
        readonly component: react.FunctionComponent<WidgetProps<never>>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Info";
        readonly component: react.FunctionComponent<InfoWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "[Ribbon]";
        readonly component: react.FunctionComponent<TabsWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Button";
        readonly component: react.FunctionComponent<ButtonWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Custom Content";
        readonly component: react.FunctionComponent<CustomContentWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Row Count";
        readonly component: react.FunctionComponent<RowCountWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Application Name";
        readonly component: react.FunctionComponent<ApplicationNameWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Custom";
        readonly component: react.FunctionComponent<CustomWidgetProps>;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly label: "Column Chooser";
        readonly component: ({ orientation, location }: ColumnChooserWidgetProps) => JSX.Element;
        readonly getDefaultWidgetSize: typeof getWidgetSize;
        readonly instances: WidgetInstanceType.Multiple;
    } | {
        readonly component: react.FunctionComponent<ThemeWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<ViewWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<StyledCellsWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<QuickSearchWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<CalculatedColumnWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<SettingsPanelWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<DashboardWidgetProps>;
        readonly label: "Dashboard";
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<FlashingCellsWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: (props: ExportWidgetProps) => JSX.Element;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: (props: CellSummaryWidgetProps) => JSX.Element;
        readonly label: string;
        readonly instances: WidgetInstanceType.Multiple;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    } | {
        readonly component: react.FunctionComponent<AlertWidgetProps>;
        readonly label: string;
        readonly instances: WidgetInstanceType.Single;
        readonly getDefaultWidgetSize: (_options: {
            location: WidgetLocation;
            orientation: "horizontal" | "vertical";
        }) => Partial<{
            width: number;
            height: number;
        }>;
    };

getWidgetLabel(widgetType: WidgetIdType): string;

setCellSummaryAggregationFunctionForWidget(fnName: AggregationFunctionType, dashboardWidgetId: string): void;

setDashboardBarWidgets(position: DashboardPosition, widgetsState: WidgetState[]): void;

setDashboardDrawerSize(position: DashboardPosition, size: number): void;

setDashboardStyle(position: DashboardPosition, style: DashboardSection['style']): void;

setDashboardTabs(position: DashboardPosition, tabItems: DashboardRibbonDefinition['tabs']): void;

setOpenTabName(position: DashboardPosition, tabName: string | null): void;