import { type RenderMode } from "../../types.js"; import { type IDashboardCommand } from "./base.js"; /** * @beta */ export interface IRenderModeChangeOptions { readonly resetDashboard: boolean; } /** * Payload of the {@link IChangeRenderMode} command. * @beta */ export interface IChangeRenderModePayload { readonly renderMode: RenderMode; readonly renderModeChangeOptions: IRenderModeChangeOptions; } /** * @beta */ export interface IChangeRenderMode extends IDashboardCommand { readonly type: "GDC.DASH/CMD.CHANGE_RENDER_MODE"; readonly payload: IChangeRenderModePayload; } /** * Creates the ChangeRenderMode command. Dispatching this command will result in change of the render mode of dashboard component * * @param renderMode - render mode value * @param renderModeChangeOptions - options for render mode change * @param correlationId - specify correlation id to use for this command. this will be included in all * events that will be emitted during the command processing * * @beta */ export declare function changeRenderMode(renderMode: RenderMode, renderModeChangeOptions?: IRenderModeChangeOptions, correlationId?: string): IChangeRenderMode; /** * Creates the ChangeRenderMode command for switch to edit mode. * * @param correlationId - specify correlation id to use for this command. this will be included in all * events that will be emitted during the command processing * * @beta */ export declare function switchToEditRenderMode(correlationId?: string): IChangeRenderMode; /** * Creates the ChangeRenderMode command for cancel edit mode. * * @param correlationId - specify correlation id to use for this command. this will be included in all * events that will be emitted during the command processing * * @beta */ export declare function cancelEditRenderMode(correlationId?: string): IChangeRenderMode; //# sourceMappingURL=renderMode.d.ts.map