类: FUniver

get Enum(): FEnum

get Event(): FEventName

get Util(): FUtil

addEvent<T>(event, callback): IDisposable

// 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()`

addWatermark(type, config): FUniver

addWatermark(type, config): FUniver

addWatermark(type, config): FUniver

copy(): Promise<boolean>

createMenu(menuItem): FMenu

univerAPI.createMenu({
  id: 'custom-menu',
  title: 'Custom Menu',
  action: () => {},
}).appendTo('ribbon.start.others');

createSubmenu(submenuItem): FSubmenu

univerAPI.createSubmenu({ id: 'custom-submenu', title: 'Custom Submenu' })
  .addSubmenu(univerAPI.createSubmenu({ id: 'submenu-nested', title: 'Nested Submenu' })
    .addSubmenu(univerAPI.createMenu({ id: 'submenu-nested-1', title: 'Item 1', action: () => {} }))
    .addSeparator()
    .addSubmenu(univerAPI.createMenu({ id: 'submenu-nested-2', title: 'Item 2', action: () => {} }))
  )
  .appendTo('contextMenu.others');

createTextFinderAsync(text): Promise<FTextFinder>

// Assume the current sheet is empty sheet.
const fWorkbook = univerAPI.getActiveWorkbook();
const fWorksheet = fWorkbook.getActiveSheet();
const fRange = fWorksheet.getRange('A1:D10');
fRange.setValues([
  [1, 2, 3, 4],
  [2, 3, 4, 5],
  [3, 4, 5, 6],
  [4, 5, 6, 7],
  [5, 6, 7, 8],
  [6, 7, 8, 9],
  [7, 8, 9, 10],
  [8, 9, 10, 11],
  [9, 10, 11, 12],
  [10, 11, 12, 13]
]);
 
// Create a text-finder to find the text '5'.
const textFinder = await univerAPI.createTextFinderAsync('5');
 
// Find all cells that contain the text '5'.
const matchCells = textFinder.findAll();
matchCells.forEach((cell) => {
  console.log(cell.getA1Notation()); // D2, C3, B4, A5
});

createUniverDoc(data): FDocument

createUniverSheet(data): FWorkbook

createWorkbook(data, options?): FWorkbook

const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' });
console.log(fWorkbook);

const fWorkbook = univerAPI.createWorkbook({ id: 'Sheet1', name: 'Sheet1' }, { makeCurrent: false });
console.log(fWorkbook);

customizeColumnHeader(cfg): void

univerAPI.customizeColumnHeader({ headerStyle: { fontColor: '#fff', size: 40, backgroundColor: '#4e69ee', fontSize: 9 }, columnsCfg: ['MokaII', undefined, null, { text: 'Size', textAlign: 'left' }] });

customizeRowHeader(cfg): void

univerAPI.customizeRowHeader({ headerStyle: { backgroundColor: 'pink', fontSize: 9 }, rowsCfg: ['MokaII', undefined, null, { text: 'Size', textAlign: 'left' }] });

deleteWatermark(): FUniver

disposeUnit(unitId): boolean

const fWorkbook = univerAPI.getActiveWorkbook();
const unitId = fWorkbook?.getId();
 
if (unitId) {
  univerAPI.disposeUnit(unitId);
}

executeCommand<P, R>(
   id, 
   params?, 
options?): Promise<R>

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

exportXLSXBySnapshot(snapshot): Promise<File>

exportXLSXBySnapshotAsync(snapshot): Promise<File>

const file = await univerAPI.exportXLSXBySnapshotAsync(snapshot);

exportXLSXByUnitId(unitId): Promise<File>

exportXLSXByUnitIdAsync(unitId): Promise<File>

const file = await univerAPI.exportXLSXByUnitIdAsync(unitId);

generatePivotTable<T>(data, CustomDataFieldManager?): FGenericPivotTable

const sourceData = [
 ["区域", "省份", "城市", "类别", "商品", "数量", "销售日期"],
 ["西部", "河南", "洛阳", "fruit", "葡萄", 38, "2021-06-30"],
 ["北部", "辽宁", "沈阳", "fruit", "葡萄", 45, "2023-08-31"]
]
const pivot = univerAPI.generatePivotTable(sourceData);
pivot.addFieldWithName('数量', 3);
const res = pivot.getResultByCalculate();
console.log('debugger', pivot, res);

getActiveDocument(): FDocument

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

const target = univerAPI.getActiveSheet();
if (!target) return;
const { workbook, worksheet } = target;
console.log(workbook, worksheet);

getActiveUniverSheet(): FWorkbook

getActiveWorkbook(): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook();
console.log(fWorkbook);

getCollaboration(): FCollaboration

const collaboration = univerAPI.getCollaboration();

getCommandSheetTarget(commandInfo): Nullable<{
  workbook: ...;
  worksheet: ...;
}>

univerAPI.addEvent(univerAPI.Event.CommandExecuted, (commandInfo) => {
  const target = univerAPI.getCommandSheetTarget(commandInfo);
  if (!target) return;
  const { workbook, worksheet } = target;
  console.log(workbook, worksheet);
});

getComponentManager(): ComponentManager

getCrosshairHighlightColor(): string

console.log(univerAPI.getCrosshairHighlightColor());

getCrosshairHighlightEnabled(): boolean

console.log(univerAPI.getCrosshairHighlightEnabled());

getCurrentLifecycleStage(): LifecycleStages

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

getFormula(): FFormula

getHooks(): FHooks

getPermission(): FPermission

getSheetHooks(): FSheetHooks

getSheetTarget(unitId, subUnitId): Nullable<{
  workbook: ...;
  worksheet: ...;
}>

const unitId = 'workbook-01';
const subUnitId = 'sheet-0001';
const target = univerAPI.getSheetTarget(unitId, subUnitId);
if (!target) return;
const { workbook, worksheet } = target;
console.log(workbook, worksheet);

getShortcut(): FShortcut

getUniverDoc(id): FDocument

getUniverSheet(id): FWorkbook

const fWorkbook = univerAPI.getUniverSheet('Sheet1');
console.log(fWorkbook);
 
const fWorkbook = univerAPI.getWorkbook('Sheet1');
console.log(fWorkbook);

getURL(): URL

getUserManager(): FUserManager

getWorkbook(id): FWorkbook

importDOCXToSnapshot(file): Promise<IDocumentData>

importDOCXToSnapshotAsync(file): Promise<IDocumentData>

const snapshot = await univerAPI.importDOCXToSnapshotAsync(file);

importDOCXToUnitId(file): Promise<string>

importDOCXToUnitIdAsync(file): Promise<string>

const unitId = await univerAPI.importDOCXToUnitIdAsync(file);

importXLSXToSnapshot(file): Promise<IWorkbookData>

importXLSXToSnapshotAsync(file): Promise<IWorkbookData>

const snapshot = await univerAPI.importXLSXToSnapshotAsync(file);

importXLSXToUnitId(file): Promise<string>

importXLSXToUnitIdAsync(file): Promise<string>

const unitId = await univerAPI.importXLSXToUnitIdAsync(file);

isUIVisible(key): boolean

univerAPI.isUIVisible(BuiltInUIPart.HEADER);

newBlob(): FBlob

const blob = univerAPI.newBlob();

newColor(): ColorBuilder

const color = univerAPI.newColor();

newDataValidation(): FDataValidationBuilder

const rule = FUnvier.newDataValidation();
cell.setDataValidation(rule.requireValueInRange(range));

newDefinedName(): FDefinedNameBuilder

const fWorkbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setRef('Sheet1!$A$1')
  .setName('MyDefinedName')
  .setComment('This is a comment');
console.log(definedNameBuilder);
fWorkbook.insertDefinedNameBuilder(definedNameBuilder.build());

newParagraphStyle(style?): ParagraphStyleBuilder

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(style?): ParagraphStyleValue

const paragraphStyleValue = univerAPI.newParagraphStyleValue();

newRichText(data?): RichTextBuilder

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

newRichTextValue(data): RichTextValue

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

newTextDecoration(decoration?): TextDecorationBuilder

const decoration = univerAPI.newTextDecoration();

newTextStyle(style?): TextStyleBuilder

const textStyle = univerAPI.newTextStyle();

newTextStyleValue(style?): TextStyleValue

const textStyleValue = univerAPI.newTextStyleValue();

newTheadComment(): FTheadCommentBuilder

const comment = univerAPI.newTheadComment().setContent(univerAPI.newRichText().insertText('hello zhangsan'));

onBeforeCommandExecute(callback): IDisposable

onCommandExecuted(callback): IDisposable

onCommentAdded(callback): IDisposable

onCommentDeleted(callback): IDisposable

onCommentResolved(callback): IDisposable

onCommentUpdated(callback): IDisposable

onUniverSheetCreated(callback): IDisposable

openDialog(dialog): IDisposable

openSidebar(params): IDisposable

openSiderbar(params): IDisposable

paste(): Promise<boolean>

redo(): Promise<boolean>

univerAPI.redo();

registerComponent(
   name, 
   component, 
   options?): IDisposable

univerAPI.registerComponent('my-comp', () => React.createElement('h1', null, 'Custom Header'));

registerFunction(config): IDisposable

registerSheetColumnHeaderExtension(unitId, ...extensions): IDisposable

registerSheetMainExtension(unitId, ...extensions): IDisposable

registerSheetRowHeaderExtension(unitId, ...extensions): IDisposable

registerUIPart(key, component): IDisposable

univerAPI.registerUIPart(BuiltInUIPart.CUSTOM_HEADER, () => React.createElement('h1', null, 'Custom Header'));

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

setCrosshairHighlightColor(color): FUniver

univerAPI.setCrosshairHighlightColor('#FF0000');
// or
univerAPI.setCrosshairHighlightColor('rgba(232, 11, 11, 0.2)');

setCrosshairHighlightEnabled(enabled): FUniver

univerAPI.setCrosshairHighlightEnabled(true);

setCurrent(unitId): void

univerAPI.setCurrent('unit2');

setUIVisible(key, visible): FUniver

univerAPI.setUIVisible(BuiltInUIPart.HEADER, false);

showMessage(options): void

const message = univerAPI.showMessage({ key: 'my-message', content: 'Warning', duration: 0 });
 
someAction().then(() => message.dispose());

syncExecuteCommand<P, R>(
   id, 
   params?, 
   options?): R

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

undo(): Promise<boolean>

univerAPI.undo();

static newAPI(wrapped): FUniver

const univerAPI = FUniver.newAPI(univer);