@kieler/klighd-core/lib/sidebar/actions.d.ts

Core KLighD diagram visualization with Sprotty

import { SetUIExtensionVisibilityAction } from 'sprotty';
import { Action } from 'sprotty-protocol';
/** Wrapper action around {@link SetUIExtensionVisibilityAction} which shows the sidebar. */
export type ShowSidebarAction = SetUIExtensionVisibilityAction;
export declare namespace ShowSidebarAction {
    function create(): ShowSidebarAction;
}
/**
 * Action used to toggle a registered sidebar panel in the sidebar. This may open
 * the sidebar if it is currently closed or replace the current panel with the
 * panel that should be toggled. If the panel is already shown, it is hidden and
 * the sidebar is closed.
 */
export interface ToggleSidebarPanelAction extends Action {
    kind: typeof ToggleSidebarPanelAction.KIND;
    id: string;
    state?: 'show' | 'hide';
}
export declare namespace ToggleSidebarPanelAction {
    const KIND = "toggleSidebarPanel";
    /**
     * Creates a new {@link ToggleSidebarPanelAction}.
     * @param id ID if the registered panel that should be shown.
     * @param state Explicitly sets the new state for the panel. If this parameter is
     * absent, the current state is toggled.
     */
    function create(id: string, state?: 'show' | 'hide'): ToggleSidebarPanelAction;
    /** Type predicate to narrow an action to this action. */
    function isThisAction(action: Action): action is ToggleSidebarPanelAction;
}
//# sourceMappingURL=actions.d.ts.map