FWorkbook

addStyles(styles: Record<string, IStyleData>): void

const fWorkbook = univerAPI.getActiveWorkbook()

// Add styles to the workbook styles
const styles = {
  'custom-style-1': {
    bg: {
      rgb: 'rgb(255, 0, 0)',
    },
  },
  'custom-style-2': {
    fs: 20,
    n: {
      pattern: '@',
    },
  },
}
fWorkbook.addStyles(styles)

// Set values with the new styles
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
  [{ v: 'To', s: 'custom-style-1' }, { v: '0001', s: 'custom-style-2' }],
])

create(name: string, rows: number, columns: number, options?: { index?: number; sheet?: Partial<IWorksheetData> }): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()

// Create a new sheet named 'MyNewSheet' with 10 rows and 10 columns
const newSheet = fWorkbook.create('MyNewSheet', 10, 10)
console.log(newSheet)

// Create a new sheet named 'MyNewSheetWithData' with 10 rows and 10 columns and some data, and set it as the first sheet
const sheetData = {
  // ... Omit other properties
  cellData: {
    0: {
      0: {
        v: 'Hello Univer!',
      },
    },
  },
  // ... Omit other properties
}
const newSheetWithData = fWorkbook.create('MyNewSheetWithData', 10, 10, {
  index: 0,
  sheet: sheetData,
})
console.log(newSheetWithData)

createRangeThemeStyle(themeName: string, themeStyleJson?: Omit<IRangeThemeStyleJSON, 'name'>): RangeThemeStyle

const fWorkbook = univerAPI.getActiveWorkbook()
const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {
  secondRowStyle: {
    bg: {
      rgb: 'rgb(214,231,241)',
    },
  },
})
console.log(rangeThemeStyle)

deleteActiveSheet(): boolean

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.deleteActiveSheet()

deleteDefinedName(name: string): boolean

// The code below deletes the defined name with the given name
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.deleteDefinedName('MyDefinedName')

deleteSheet(sheet: FWorksheet | string): boolean

// The code below deletes the specified worksheet
const fWorkbook = univerAPI.getActiveWorkbook()
const sheet = fWorkbook.getSheets()[1]
fWorkbook.deleteSheet(sheet)

// The code below deletes the specified worksheet by id
// fWorkbook.deleteSheet(sheet.getSheetId());

dispose(): void

duplicateActiveSheet(): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()
const duplicatedSheet = fWorkbook.duplicateActiveSheet()
console.log(duplicatedSheet)

duplicateSheet(sheet: FWorksheet): FWorksheet

// The code below duplicates the given worksheet
const fWorkbook = univerAPI.getActiveWorkbook()
const activeSheet = fWorkbook.getActiveSheet()
const duplicatedSheet = fWorkbook.duplicateSheet(activeSheet)
console.log(duplicatedSheet)

getActiveCell(): FRange | null

const fWorkbook = univerAPI.getActiveWorkbook()
console.log(fWorkbook.getActiveCell().getA1Notation())

getActiveRange(): FRange | null

const fWorkbook = univerAPI.getActiveWorkbook()
const activeRange = fWorkbook.getActiveRange()
console.log(activeRange)

getActiveSheet(): FWorksheet

// The code below gets the active sheet of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
console.log(fWorksheet)

getCustomMetadata(): CustomData | undefined

const fWorkbook = univerAPI.getActiveWorkbook()
const custom = fWorkbook.getCustomMetadata()
console.log(custom)

getDefinedName(name: string): FDefinedName | null

// The code below gets the defined name by name
const fWorkbook = univerAPI.getActiveWorkbook()
const definedName = fWorkbook.getDefinedName('MyDefinedName')
console.log(definedName?.getFormulaOrRefString())

if (definedName) {
  definedName.setName('NewDefinedName')
}

getDefinedNames(): FDefinedName[]

// The code below gets all the defined names in the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const definedNames = fWorkbook.getDefinedNames()
console.log(definedNames, definedNames[0]?.getFormulaOrRefString())

getId(): string

// The code below gets the id of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const unitId = fWorkbook.getId()
console.log(unitId)

getLocale(): LocaleType

// The code below gets the locale of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
console.log(fWorkbook.getLocale())

getName(): string

// The code below gets the name of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const name = fWorkbook.getName()
console.log(name)

getNumSheets(): number

// The code below gets the number of sheets in the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
console.log(fWorkbook.getNumSheets())

getPermission(): FPermission

const fWorkbook = univerAPI.getActiveWorkbook()
const permission = fWorkbook.getPermission()
console.log(permission)

getRegisteredRangeThemes(): string[]

// The code below gets the registered range themes
const fWorkbook = univerAPI.getActiveWorkbook()
const themes = fWorkbook.getRegisteredRangeThemes()
console.log(themes)

getSheetByName(name: string): FWorksheet | null

// The code below gets a worksheet by sheet name
const fWorkbook = univerAPI.getActiveWorkbook()
const sheet = fWorkbook.getSheetByName('Sheet1')
console.log(sheet)

getSheetBySheetId(sheetId: string): FWorksheet | null

// The code below gets a worksheet by sheet id
const fWorkbook = univerAPI.getActiveWorkbook()
const sheet = fWorkbook.getSheetBySheetId('sheetId')
console.log(sheet)

getSheets(): FWorksheet[]

// The code below gets all the worksheets in the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const sheets = fWorkbook.getSheets()
console.log(sheets)

getSnapshot(): IWorkbookData

// The code below saves the workbook snapshot data
const activeSpreadsheet = univerAPI.getActiveWorkbook()
const snapshot = activeSpreadsheet.getSnapshot()

getUrl(): string

// The code below gets the URL of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
const url = fWorkbook.getUrl()
console.log(url)

getWorkbook(): Workbook

// The code below gets the Workbook instance
const fWorkbook = univerAPI.getActiveWorkbook()
const workbook = fWorkbook.getWorkbook()
console.log(workbook)

getWorkbookPermission(): FWorkbookPermission

const fWorkbook = univerAPI.getActiveWorkbook()
const permission = fWorkbook.getWorkbookPermission()

// Set workbook to read-only mode
await permission.setMode('viewer')

// Add a collaborator
await permission.addCollaborator({
  userId: 'user123',
  name: 'John Doe',
  role: 'editor',
})

// Subscribe to permission changes
permission.permission$.subscribe((snapshot) => {
  console.log('Permissions changed:', snapshot)
})

insertDefinedName(name: string, formulaOrRefString: string): FWorkbook

// The code below inserts a defined name
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.insertDefinedName('MyDefinedName', 'Sheet1!$A$1')

insertDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

// The code below inserts a defined name by builder param
const fWorkbook = univerAPI.getActiveWorkbook()
const definedNameBuilder = univerAPI.newDefinedName()
  .setRef('Sheet1!$A$1')
  .setName('MyDefinedName')
  .setComment('This is a comment')
  .build()
fWorkbook.insertDefinedNameBuilder(definedNameBuilder)

insertSheet(sheetName?: string, options?: { index?: number; sheet?: Partial<IWorksheetData> }): FWorksheet

const fWorkbook = univerAPI.getActiveWorkbook()

// Create a new sheet with default configuration
const newSheet = fWorkbook.insertSheet()
console.log(newSheet)

// Create a new sheet with custom name and default configuration
const newSheetWithName = fWorkbook.insertSheet('MyNewSheet')
console.log(newSheetWithName)

// Create a new sheet with custom name and custom configuration
const sheetData = {
  // ... Omit other properties
  cellData: {
    0: {
      0: {
        v: 'Hello Univer!',
      },
    },
  },
  // ... Omit other properties
}
const newSheetWithData = fWorkbook.insertSheet('MyNewSheetWithData', {
  index: 0,
  sheet: sheetData,
})
console.log(newSheetWithData)

moveActiveSheet(index: number): FWorkbook

// The code below moves the active sheet to the specified index
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.moveActiveSheet(1)

moveSheet(sheet: FWorksheet, index: number): FWorkbook

// The code below moves the sheet to the specified index
const fWorkbook = univerAPI.getActiveWorkbook()
const sheet = fWorkbook.getActiveSheet()
fWorkbook.moveSheet(sheet, 1)

onBeforeCommandExecute(callback: CommandListener): IDisposable

// The code below registers a callback that will be triggered before invoking a command targeting the Univer sheet
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.onBeforeCommandExecute((command) => {
  console.log('Before command execute:', command)
})

onCommandExecuted(callback: CommandListener): IDisposable

// The code below registers a callback that will be triggered when a command is invoked targeting the Univer sheet
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.onCommandExecuted((command) => {
  console.log('Command executed:', command)
})

onSelectionChange(callback: (selections: IRange[]) => void): IDisposable

// The code below registers a callback that will be triggered when the selection changes
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.onSelectionChange((selections) => {
  console.log('Selection changed:', selections)
})

redo(): FWorkbook

// The code below redoes the last undone action
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.redo()

registerRangeTheme(rangeThemeStyle: RangeThemeStyle): void

const fWorkbook = univerAPI.getActiveWorkbook()
const rangeThemeStyle = fWorkbook.createRangeThemeStyle('MyTheme', {
  secondRowStyle: {
    bg: {
      rgb: 'rgb(214,231,241)',
    },
  },
})
fWorkbook.registerRangeTheme(rangeThemeStyle)

removeStyles(styleKeys: string[]): void

const fWorkbook = univerAPI.getActiveWorkbook()

// Add styles to the workbook styles
const styles = {
  'custom-style-1': {
    bg: {
      rgb: 'rgb(255, 0, 0)',
    },
  },
  'custom-style-2': {
    fs: 20,
    n: {
      pattern: '@',
    },
  },
}
fWorkbook.addStyles(styles)

// Set values with the new styles
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  [{ v: 'Hello', s: 'custom-style-1' }, { v: 'Univer', s: 'custom-style-1' }],
  [{ v: 'To', s: 'custom-style-1' }, { v: '0001', s: 'custom-style-2' }],
])

// Remove the style `custom-style-1` after 2 seconds
setTimeout(() => {
  fWorkbook.removeStyles(['custom-style-1'])
  fWorksheet.refreshCanvas()
}, 2000)

save(): IWorkbookData

// The code below saves the workbook snapshot data
const fWorkbook = univerAPI.getActiveWorkbook()
const snapshot = fWorkbook.save()
console.log(snapshot)

setActiveRange(range: FRange): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook()
const range = fWorkbook.getActiveSheet().getRange('A10:B10')
fWorkbook.setActiveRange(range)

setActiveSheet(sheet: FWorksheet | string): FWorksheet

// The code below sets the given worksheet to be the active worksheet
const fWorkbook = univerAPI.getActiveWorkbook()
const sheet = fWorkbook.getSheets()[1]
fWorkbook.setActiveSheet(sheet)

setCustomMetadata(custom: CustomData | undefined): FWorkbook

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.setCustomMetadata({ key: 'value' })

setEditable(value: boolean): FWorkbook

// The code below sets the editing permissions of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.setEditable(false)

setLocale(locale: LocaleType): void

setName(name: string): this

// The code below sets the name of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.setName('MyWorkbook')

setSpreadsheetLocale(locale: LocaleType): FWorkbook

// The code below sets the locale of the workbook
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.setSpreadsheetLocale(univerAPI.Enum.LocaleType.EN_US)
console.log(fWorkbook.getLocale())

undo(): FWorkbook

// The code below undoes the last action
const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.undo()

unregisterRangeTheme(themeName: string): void

const fWorkbook = univerAPI.getActiveWorkbook()
fWorkbook.unregisterRangeTheme('MyTheme')

updateDefinedNameBuilder(param: ISetDefinedNameMutationParam): void

// The code below updates the defined name with the given name
const fWorkbook = univerAPI.getActiveWorkbook()
const definedName = fWorkbook.getDefinedName('MyDefinedName')
console.log(definedName?.getFormulaOrRefString())

// Update the defined name
if (definedName) {
  const newDefinedNameParam = definedName.toBuilder()
    .setName('NewDefinedName')
    .setRef('Sheet1!$A$2')
    .build()
  fWorkbook.updateDefinedNameBuilder(newDefinedNameParam)
}