@univerjs-pro/sheets-exchange-client
Spreadsheet import and export client integration for Web SDK.
TypeScript
import { UniverSheetsExchangeClientPlugin } from '@univerjs-pro/sheets-exchange-client'univer.registerPlugin(UniverSheetsExchangeClientPlugin)Entry Points
- Facade:
@univerjs-pro/sheets-exchange-client/facade - Locale:
@univerjs-pro/sheets-exchange-client/locale/*
Facade API
TypeScript
import '@univerjs-pro/sheets-exchange-client/facade'importSheetToUnitIdAsync(file: File | string): Promise<string | undefined>importSheetToSnapshotAsync(file: File | string): Promise<IWorkbookData | undefined>exportSheetByUnitIdAsync(unitId: string, format?: ExchangeFormat, sheetId?: string): Promise<File | undefined>exportSheetBySnapshotAsync(snapshot: IWorkbookData, format?: ExchangeFormat, sheetId?: string): Promise<File | undefined>transformSnapshotJsonToWorkbookDataAsync(json: ISnapshotBlockJsonResponse): Promise<IWorkbookData>transformWorkbookDataToSnapshotJsonAsync(workbookData: IWorkbookData): Promise<ISnapshotBlockJson>IUniverSheetsExchangeClientConfig
TypeScript
import type { MenuConfig } from '@univerjs/ui'export interface IUniverSheetsExchangeClientConfig { menu?: MenuConfig minSheetRowCount?: number minSheetColumnCount?: number disableCellImageConversion?: boolean}Imported worksheets have at least minSheetRowCount rows and minSheetColumnCount columns (both default to 1). disableCellImageConversion defaults to true; exporting URL-backed cell images uses links instead of asking the server to download each image.
How is this guide?