univerAPI

The root Facade API object to interact with Univer. Please use newAPI static method to create a new instance.

This class should not be instantiated directly. Use factory methods on univerAPI instead.

Overview

@univerjs/core

@univerjs/docs-ui

@univerjs/engine-formula

@univerjs/network

@univerjs/sheets

@univerjs/sheets-crosshair-highlight

@univerjs/sheets-data-validation

@univerjs/sheets-drawing-ui

@univerjs/sheets-find-replace

@univerjs/sheets-formula

@univerjs/sheets-formula-ui

@univerjs/sheets-thread-comment

@univerjs/sheets-ui

@univerjs/ui

@univerjs/watermark

@univerjs-pro/collaboration-client

@univerjs-pro/collaboration-client-ui

@univerjs-pro/exchange-client

@univerjs-pro/live-share

@univerjs-labs/local-snapshot-manager

@univerjs-labs/mcp

@univerjs-labs/sheets-mcp

APIs

Creation & Bootstrap

createMenu

Signature

createMenu(menuItem: IFacadeMenuItem): FMenu

Parameters

• menuItem IFacadeMenuItem — No description

Returns

• FMenu — See signature above.

createSocket

Signature

createSocket(url: string): ISocket

Parameters

• url string — No description

Returns

• ISocket — See signature above.

createSubmenu

Signature

createSubmenu(submenuItem: IFacadeSubmenuItem): FSubmenu

Parameters

• submenuItem IFacadeSubmenuItem — No description

Returns

• FSubmenu — See signature above.

createTextFinderAsync

Signature

async createTextFinderAsync(text: string): Promise<FTextFinder | null>

Parameters

• text string — No description

Returns

• Promise<FTextFinder> — See signature above.

createUniverDoc

Signature

createUniverDoc(data: Partial<IDocumentData>): FDocument

Parameters

• data Partial<IDocumentData> — No description

Returns

• FDocument — See signature above.

createUniverSheet

Signature

createUniverSheet(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook

Parameters

• data Partial<IWorkbookData> — No description
• options ICreateUnitOptions (optional) — No description

Returns

• FWorkbook — See signature above.

createWorkbook

Signature

createWorkbook(data: Partial<IWorkbookData>, options?: ICreateUnitOptions): FWorkbook

Parameters

• data Partial<IWorkbookData> — No description
• options ICreateUnitOptions (optional) — No description

Returns

• FWorkbook — See signature above.

disposeUnit

Dispose the UniverSheet by the unitId. The UniverSheet would be unload from the application.

Signature

disposeUnit(unitId: string): boolean

Parameters

• unitId string — No description

Returns

• boolean — Whether the Univer instance is disposed successfully.

Examples

const fWorkbook = univerAPI.getActiveWorkbook();
const unitId = fWorkbook?.getId();

if (unitId) {
  univerAPI.disposeUnit(unitId);
}

newAPI

Create an FUniver instance, if the injector is not provided, it will create a new Univer instance.

Signature

static newAPI(wrapped: Univer | Injector): FUniver

Parameters

• wrapped any — No description

Returns

• FUniver — - The FUniver instance.

Tags

• @static — *

Examples

const univerAPI = FUniver.newAPI(univer);

Unit & Workbook

getActiveWorkbook

Signature

getActiveWorkbook(): FWorkbook | null

Returns

• FWorkbook — See signature above.

Commands

executeCommand

Execute a command with the given id and parameters.

Signature

executeCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): Promise<R>

Parameters

• id string — No description
• params P (optional) — No description
• options IExecutionOptions (optional) — No description

Returns

• Promise<R> — The result of the execution. It is a boolean value by default which indicates the command is executed.

Examples

univerAPI.executeCommand('sheet.command.set-range-values', {
  value: { v: "Hello, Univer!" },
  range: { startRow: 0, startColumn: 0, endRow: 0, endColumn: 0 }
});

redo

Redo an editing on the currently focused document.

Signature

redo(): Promise<boolean>

Returns

• Promise<boolean> — redo result

Examples

await univerAPI.redo();

syncExecuteCommand

Execute a command with the given id and parameters synchronously.

Signature

syncExecuteCommand<P extends object = object, R = boolean>(id: string, params?: P, options?: IExecutionOptions): R

Parameters

• id string — No description
• params P (optional) — No description
• options IExecutionOptions (optional) — No description

Returns

• R — The result of the execution. It is a boolean value by default which indicates the command is executed.

Examples

univerAPI.syncExecuteCommand('sheet.command.set-range-values', {
  value: { v: "Hello, Univer!" },
  range: { startRow: 0, startColumn: 0, endRow: 0, endColumn: 0 }
});

undo

Undo an editing on the currently focused document.

Signature

undo(): Promise<boolean>

Returns

• Promise<boolean> — undo result

Examples

await univerAPI.undo();

Events

addEvent

Add an event listener

Signature

addEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): IDisposable

Parameters

• event T — No description
• callback (params: IEventParamConfig[T]) => void — when event triggered

Returns

• IDisposable — The Disposable instance, for remove the listener

Examples

// Add life cycle changed event listener
const disposable = univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
  const { stage } = params;
  console.log('life cycle changed', params);
});

// Remove the event listener, use `disposable.dispose()`

fireEvent

Fire an event, used in internal only.

Signature

fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefined

Parameters

• event T — No description
• params IEventParamConfig[T] — of event

Returns

• boolean — should cancel

Examples

this.fireEvent(univerAPI.Event.LifeCycleChanged, params);

registerEventHandler

Signature

registerEventHandler: (event: string, handler: () => any) => IDisposable

Returns

• (event: string, handler: () => any) => IDisposable — See signature above.

Factories

newBlob

Create a new blob.

Signature

newBlob(): FBlob

Returns

• FBlob — The new blob instance

Examples

const blob = univerAPI.newBlob();

newDataValidation

Signature

static newDataValidation(): FDataValidationBuilder

Returns

• FDataValidationBuilder — A new instance of the FDataValidationBuilder class

newDefinedName

Signature

newDefinedName(): FDefinedNameBuilder

Returns

• FDefinedNameBuilder — See signature above.

newParagraphStyle

Create a new paragraph style.

Signature

newParagraphStyle(style?: IParagraphStyle): ParagraphStyleBuilder

Parameters

• style IParagraphStyle (optional) — No description

Returns

• ParagraphStyleBuilder — The new paragraph style instance

Examples

const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
const paragraphStyle = univerAPI.newParagraphStyle({ textStyle: { ff: 'Arial', fs: 12, it: univerAPI.Enum.BooleanNumber.TRUE, bl: univerAPI.Enum.BooleanNumber.TRUE } });
richText.insertParagraph(paragraphStyle);
const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
range.setRichTextValueForCell(richText);

newParagraphStyleValue

Create a new paragraph style value.

Signature

newParagraphStyleValue(style?: IParagraphStyle): ParagraphStyleValue

Parameters

• style IParagraphStyle (optional) — No description

Returns

• ParagraphStyleValue — The new paragraph style value instance

Examples

const paragraphStyleValue = univerAPI.newParagraphStyleValue();

newRichText

Create a new rich text.

Signature

newRichText(data?: IDocumentData): RichTextBuilder

Parameters

• data IDocumentData (optional) — No description

Returns

• RichTextBuilder — The new rich text instance

Examples

const richText = univerAPI.newRichText({ body: { dataStream: 'Hello World\r\n' } });
const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
range.setRichTextValueForCell(richText);

newRichTextValue

Create a new rich text value.

Signature

newRichTextValue(data: IDocumentData): RichTextValue

Parameters

• data IDocumentData — No description

Returns

• RichTextValue — The new rich text value instance

Examples

const richTextValue = univerAPI.newRichTextValue({ body: { dataStream: 'Hello World\r\n' } });
const range = univerAPI.getActiveWorkbook().getActiveSheet().getRange('A1');
range.setRichTextValueForCell(richTextValue);

newTextDecoration

Create a new text decoration.

Signature

newTextDecoration(decoration?: ITextDecoration): TextDecorationBuilder

Parameters

• decoration ITextDecoration (optional) — No description

Returns

• TextDecorationBuilder — The new text decoration instance

Examples

const decoration = univerAPI.newTextDecoration();

newTextStyle

Create a new text style.

Signature

newTextStyle(style?: ITextStyle): TextStyleBuilder

Parameters

• style ITextStyle (optional) — No description

Returns

• TextStyleBuilder — The new text style instance

Examples

const textStyle = univerAPI.newTextStyle();

newTextStyleValue

Create a new text style value.

Signature

newTextStyleValue(style?: ITextStyle): TextStyleValue

Parameters

• style ITextStyle (optional) — No description

Returns

• TextStyleValue — The new text style value instance

Examples

const textStyleValue = univerAPI.newTextStyleValue();

newTheadComment

Signature

newTheadComment(comment?: IThreadComment): FTheadCommentBuilder

Parameters

• comment IThreadComment (optional) — No description

Returns

• FTheadCommentBuilder — See signature above.

Environment

setLocale

Set the current locale.

Signature

setLocale(locale: string): void

Parameters

• locale string — No description

Examples

univerAPI.setLocale('esES');

toggleDarkMode

Toggle dark mode on or off.

Signature

toggleDarkMode(isDarkMode: boolean): void

Parameters

• isDarkMode boolean — No description

Examples

univerAPI.toggleDarkMode(true);

Miscellaneous

addFonts

Signature

addFonts(fonts: IFontConfig[]): void

Parameters

• fonts IFontConfig[] — No description

addWatermark

Signature

addWatermark(type: IWatermarkTypeEnum.Text | IWatermarkTypeEnum.Image, config: ITextWatermarkConfig | IImageWatermarkConfig): FUniver

Parameters

• type IWatermarkTypeEnum.Text | IWatermarkTypeEnum.Image — No description
• config ITextWatermarkConfig | IImageWatermarkConfig — No description

Returns

• FUniver — See signature above.

callMCPTool

Signature

callMCPTool(toolName: string, params: unknown): Promise<any>

Parameters

• toolName string — No description
• params unknown — No description

Returns

• Promise<any> — See signature above.

connectMCP

Signature

connectMCP(): void

copy

Signature

copy(): Promise<boolean>

Returns

• Promise<boolean> — See signature above.

customizeColumnHeader

Signature

customizeColumnHeader(cfg: IColumnsHeaderCfgParam): void

Parameters

• cfg IColumnsHeaderCfgParam — No description

customizeRowHeader

Signature

customizeRowHeader(cfg: IRowsHeaderCfgParam): void

Parameters

• cfg IRowsHeaderCfgParam — No description

deleteWatermark

Signature

deleteWatermark(): FUniver

Returns

• FUniver — See signature above.

disconnectMCP

Signature

disconnectMCP(): void

exportDOCXBySnapshotAsync

Signature

async exportDOCXBySnapshotAsync(snapshot: IDocumentData): Promise<File | undefined>

Parameters

• snapshot IDocumentData — No description

Returns

• Promise<File> — See signature above.

exportDOCXByUnitIdAsync

Signature

async exportDOCXByUnitIdAsync(unitId: string): Promise<File | undefined>

Parameters

• unitId string — No description

Returns

• Promise<File> — See signature above.

exportXLSXBySnapshotAsync

Export XLSX file by workbook data

Signature

async exportXLSXBySnapshotAsync(snapshot: IWorkbookData): Promise<File | undefined>

Parameters

• snapshot IWorkbookData — No description

Returns

• Promise<File> — See signature above.

exportXLSXByUnitIdAsync

Export XLSX file by unit id

Signature

async exportXLSXByUnitIdAsync(unitId: string): Promise<File | undefined>

Parameters

• unitId string — No description

Returns

• Promise<File> — See signature above.

extend

Signature

static extend(source: any): void

Parameters

• source any — No description

getActiveDocument

Signature

getActiveDocument(): FDocument | null

Returns

• FDocument — See signature above.

getActiveSheet

Signature

getActiveSheet(): Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>

Returns

• Nullable<{ workbook: FWorkbook; worksheet: FWorksheet; }> — See signature above.

getActiveUniverSheet

Signature

getActiveUniverSheet(): FWorkbook | null

Returns

• FWorkbook — See signature above.

getAllMCPTools

Signature

getAllMCPTools(): IMCPTool[]

Returns

• IMCPTool[] — See signature above.

getCollaboration

Signature

getCollaboration(): FCollaboration

Returns

• FCollaboration — See signature above.

getCommandSheetTarget

Signature

getCommandSheetTarget(commandInfo: ICommandInfo<object>): Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>

Parameters

• commandInfo ICommandInfo<object> — No description

Returns

• Nullable<{ workbook: FWorkbook; worksheet: FWorksheet; }> — See signature above.

getComponentManager

Signature

getComponentManager(): ComponentManager

Returns

• ComponentManager — See signature above.

getCrosshairHighlightColor

Signature

getCrosshairHighlightColor(): string

Returns

• string — See signature above.

getCrosshairHighlightEnabled

Signature

getCrosshairHighlightEnabled(): boolean

Returns

• boolean — See signature above.

getCurrentLifecycleStage

Get the current lifecycle stage.

Signature

getCurrentLifecycleStage(): LifecycleStages

Returns

• LifecycleStages — - The current lifecycle stage.

Examples

const stage = univerAPI.getCurrentLifecycleStage();
console.log(stage);

getFormula

Signature

getFormula(): FFormula

Returns

• FFormula — See signature above.

getHooks

Get hooks.

Signature

getHooks(): FHooks

Returns

• FHooks — FHooks instance

getLintErrors

Signature

async getLintErrors(): Promise<ILintErrorReport>

Returns

• Promise<ILintErrorReport> — See signature above.

getLiveShareStatus

Signature

getLiveShareStatus(): LiveShareStatus

Returns

• LiveShareStatus — See signature above.

getLocalSnapshotManager

Signature

getLocalSnapshotManager(): FLocalSnapshotManager

Returns

• FLocalSnapshotManager — See signature above.

getMCPConnectionStatus

Signature

getMCPConnectionStatus(): string

Returns

• string — See signature above.

getNetwork

Signature

getNetwork(): FNetwork

Returns

• FNetwork — See signature above.

getProtectedRangeShadowStrategy

Signature

getProtectedRangeShadowStrategy(): 'always' | 'non-editable' | 'non-viewable' | 'none'

Returns

• "always" | "non-editable" | "non-viewable" | "none" — See signature above.

getProtectedRangeShadowStrategy$

Signature

getProtectedRangeShadowStrategy$(): Observable<'always' | 'non-editable' | 'non-viewable' | 'none'>

Returns

• Observable<"always" | "non-editable" | "non-viewable" | "none"> — See signature above.

getSheetHooks

Get sheet hooks.

Signature

getSheetHooks(): FSheetHooks

Returns

• FSheetHooks — FSheetHooks instance

getSheetTarget

Signature

getSheetTarget(unitId: string, subUnitId: string): Nullable<{ workbook: FWorkbook; worksheet: FWorksheet }>

Parameters

• unitId string — No description
• subUnitId string — No description

Returns

• Nullable<{ workbook: FWorkbook; worksheet: FWorksheet; }> — See signature above.

getShortcut

Signature

getShortcut(): FShortcut

Returns

• FShortcut — See signature above.

getUniverDoc

Signature

getUniverDoc(id: string): FDocument | null

Parameters

• id string — No description

Returns

• FDocument — See signature above.

getUniverSheet

Signature

getUniverSheet(id: string): FWorkbook | null

Parameters

• id string — No description

Returns

• FWorkbook — See signature above.

getURL

Signature

getURL(): URL

Returns

• URL — See signature above.

getUserManager

Signature

getUserManager(): FUserManager

Returns

• FUserManager — See signature above.

getWorkbook

Signature

getWorkbook(id: string): FWorkbook | null

Parameters

• id string — No description

Returns

• FWorkbook — See signature above.

importDOCXToSnapshotAsync

Import DOCX file to document data

Signature

async importDOCXToSnapshotAsync(file: string | File): Promise<IDocumentData | undefined>

Parameters

• file string | File — No description

Returns

• Promise<any> — See signature above.

importDOCXToUnitIdAsync

Import DOCX file to unit id

Signature

async importDOCXToUnitIdAsync(file: string | File): Promise<string | undefined>

Parameters

• file string | File — No description

Returns

• Promise<string> — See signature above.

importXLSXToSnapshotAsync

Import XLSX file to workbook data

Signature

async importXLSXToSnapshotAsync(file: string | File): Promise<IWorkbookData | undefined>

Parameters

• file string | File — No description

Returns

• Promise<any> — See signature above.

importXLSXToUnitIdAsync

Import XLSX file to unit id

Signature

async importXLSXToUnitIdAsync(file: string | File): Promise<string | undefined>

Parameters

• file string | File — No description

Returns

• Promise<string> — See signature above.

isUIVisible

Signature

isUIVisible(ui: BuiltInUIPart): boolean

Parameters

• ui BuiltInUIPart — No description

Returns

• boolean — See signature above.

loadLocales

Load locales for the given locale.

Signature

loadLocales(locale: string, locales: ILanguagePack): void

Parameters

• locale string — No description
• locales ILanguagePack — No description

Examples

univerAPI.loadLocales('esES', {
  'Hello World': 'Hola Mundo',
});

loadServerUnit

Signature

loadServerUnit(unitId: string, unitType: UniverInstanceType, subUnitId?: string): Promise<UnitModel | null>

Parameters

• unitId string — No description
• unitType UniverInstanceType — No description
• subUnitId string (optional) — No description

Returns

• Promise<any> — See signature above.

loadServerUnitOfRevision

Signature

loadServerUnitOfRevision(unitId: string, unitType: UniverInstanceType, rev: number): Promise<UnitModel | null>

Parameters

• unitId string — No description
• unitType UniverInstanceType — No description
• rev number — No description

Returns

• Promise<any> — See signature above.

onAfterCellEdit

Signature

onAfterCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable

Parameters

• callback (params: IEditorBridgeServiceVisibleParam) => void — No description

Returns

• IDisposable — See signature above.

onBeforeCellEdit

Signature

onBeforeCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable

Parameters

• callback (params: IEditorBridgeServiceVisibleParam) => void — No description

Returns

• IDisposable — See signature above.

onBeforeCommandExecute

Register a callback that will be triggered before invoking a command.

Signature

onBeforeCommandExecute(callback: CommandListener): IDisposable

Parameters

• callback CommandListener — No description

Returns

• IDisposable — The disposable instance.

onBeforeCopy

Signature

onBeforeCopy(callback: () => void): IDisposable

Parameters

• callback () => void — No description

Returns

• IDisposable — See signature above.

onBeforePaste

Signature

onBeforePaste(callback: () => void): IDisposable

Parameters

• callback () => void — No description

Returns

• IDisposable — See signature above.

onCellDragOver

Signature

onCellDragOver(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable

Parameters

• callback (cellPos: any) => void — No description

Returns

• IDisposable — See signature above.

onCellDrop

Signature

onCellDrop(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable

Parameters

• callback (cellPos: any) => void — No description

Returns

• IDisposable — See signature above.

onCellPointerMove

Signature

onCellPointerMove(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable

Parameters

• callback (cellPos: any) => void — No description

Returns

• IDisposable — See signature above.

onCellPointerOver

Signature

onCellPointerOver(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable

Parameters

• callback (cellPos: any) => void — No description

Returns

• IDisposable — See signature above.

onCellRender

Signature

onCellRender(customRender: Nullable<ICellCustomRender[]>, effect: InterceptorEffectEnum = InterceptorEffectEnum.Style, priority: number = InterceptCellContentPriority.DATA_VALIDATION): IDisposable

Parameters

• customRender Nullable<ICellCustomRender[]> — No description
• effect InterceptorEffectEnum (optional) — No description
• priority number (optional) — No description

Returns

• IDisposable — See signature above.

onCommandExecuted

Register a callback that will be triggered when a command is invoked.

Signature

onCommandExecuted(callback: CommandListener): IDisposable

Parameters

• callback CommandListener — No description

Returns

• IDisposable — The disposable instance.

onCopy

Signature

onCopy(callback: () => void): IDisposable

Parameters

• callback () => void — No description

Returns

• IDisposable — See signature above.

onPaste

Signature

onPaste(callback: () => void): IDisposable

Parameters

• callback () => void — No description

Returns

• IDisposable — See signature above.

onUniverSheetCreated

Signature

onUniverSheetCreated(callback: (workbook: FWorkbook) => void): IDisposable

Parameters

• callback (workbook: FWorkbook) => void — No description

Returns

• IDisposable — See signature above.

openDialog

Signature

openDialog(dialog: IDialogPartMethodOptions): IDisposable

Parameters

• dialog IDialogPartMethodOptions — No description

Returns

• IDisposable — See signature above.

openSidebar

Signature

openSidebar(params: ISidebarMethodOptions): IDisposable

Parameters

• params ISidebarMethodOptions — No description

Returns

• IDisposable — See signature above.

openSiderbar

Signature

openSiderbar(params: ISidebarMethodOptions): IDisposable

Parameters

• params ISidebarMethodOptions — No description

Returns

• IDisposable — See signature above.

paste

Signature

paste(): Promise<boolean>

Returns

• Promise<boolean> — See signature above.

pasteIntoSheet

Signature

pasteIntoSheet(htmlContent?: string, textContent?: string, files?: File[]): Promise<boolean>

Parameters

• htmlContent string (optional) — No description
• textContent string (optional) — No description
• files File[] (optional) — No description

Returns

• Promise<boolean> — See signature above.

registerComponent

Signature

registerComponent(name: string, component: any, options?: IComponentOptions): IDisposable

Parameters

• name string — No description
• component any — No description
• options IComponentOptions (optional) — No description

Returns

• IDisposable — See signature above.

registerFunction

Signature

registerFunction(config: IRegisterFunctionParams): IDisposable

Parameters

• config IRegisterFunctionParams — No description

Returns

• IDisposable — See signature above.

registerSheetColumnHeaderExtension

Signature

registerSheetColumnHeaderExtension(unitId: string, ...extensions: SheetExtension[]): IDisposable

Parameters

• unitId string — No description
• extensions SheetExtension[] — No description

Returns

• IDisposable — See signature above.

registerSheetMainExtension

Signature

registerSheetMainExtension(unitId: string, ...extensions: SheetExtension[]): IDisposable

Parameters

• unitId string — No description
• extensions SheetExtension[] — No description

Returns

• IDisposable — See signature above.

registerSheetRowHeaderExtension

Signature

registerSheetRowHeaderExtension(unitId: string, ...extensions: SheetExtension[]): IDisposable

Parameters

• unitId string — No description
• extensions SheetExtension[] — No description

Returns

• IDisposable — See signature above.

registerUIPart

Signature

registerUIPart(key: BuiltInUIPart, component: any): IDisposable

Parameters

• key BuiltInUIPart — No description
• component any — No description

Returns

• IDisposable — See signature above.

registerURLImageDownloader

Signature

registerURLImageDownloader(downloader: (url: string) => Promise<string>): IDisposable

Parameters

• downloader (url: string) => Promise<string> — No description

Returns

• IDisposable — See signature above.

runOnServer

Signature

runOnServer(scriptNameOrId: string, func: string, ...params: any[]): Promise<string>

Parameters

• scriptNameOrId string — No description
• func string — No description
• params any[] — No description

Returns

• Promise<string> — See signature above.

setCrosshairHighlightColor

Signature

setCrosshairHighlightColor(color: string): FUniver

Parameters

• color string — No description

Returns

• FUniver — See signature above.

setCrosshairHighlightEnabled

Signature

setCrosshairHighlightEnabled(enabled: boolean): FUniver

Parameters

• enabled boolean — No description

Returns

• FUniver — See signature above.

setCurrent

Signature

setCurrent(unitId: string): void

Parameters

• unitId string — No description

setFreezeSync

Signature

setFreezeSync(enabled: boolean): void

Parameters

• enabled boolean — No description

setPermissionDialogVisible

Signature

setPermissionDialogVisible(visible: boolean): void

Parameters

• visible boolean — No description

setProtectedRangeShadowStrategy

Signature

setProtectedRangeShadowStrategy(strategy: 'always' | 'non-editable' | 'non-viewable' | 'none'): void

Parameters

• strategy "always" | "non-editable" | "non-viewable" | "none" — No description

setUIVisible

Signature

setUIVisible(ui: BuiltInUIPart, visible: boolean): FUniver

Parameters

• ui BuiltInUIPart — No description
• visible boolean — No description

Returns

• FUniver — See signature above.

showMessage

Signature

showMessage(options: IMessageProps): FUniver

Parameters

• options IMessageProps — No description

Returns

• FUniver — See signature above.

showRangeSelectorDialog

Signature

showRangeSelectorDialog(opts: IShowRangeSelectorDialogOptions): Promise<IUnitRangeName[]>

Parameters

• opts IShowRangeSelectorDialogOptions — No description

Returns

• Promise<IUnitRangeName[]> — See signature above.

startFollowing

Signature

startFollowing(): void

startPresenting

Signature

startPresenting(): void

stopFollowing

Signature

stopFollowing(): void

stopPresenting

Signature

stopPresenting(): void

validateMCPToolCall

Signature

validateMCPToolCall(toolName: string, params: unknown): { isValid: boolean; error?: string; validatedParams?: any }

Parameters

• toolName string — No description
• params unknown — No description

Returns

• { isValid: boolean; error?: string; validatedParams?: any; } — See signature above.