Class: FWorkbookConditionalFormattingMixin

The Disposable instance, for remove the listener

Example

univerAPI.addEvent(univerAPI.event.UnitCreated, (params) => {
    console.log('unit created', params);
});

Inherited from

FWorkbook.addEvent

addUIEvent()

addUIEvent(event, _callback): void

Defined in: sheets/src/facade/f-workbook.ts:100

Parameters

Parameter	Type
`event`	keyof `IEventParamConfig`
`_callback`	(`params`) => `void`

Returns

void

Inherited from

FWorkbook.addUIEvent

create()

create(
   name, 
   rows, 
   column): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:226

Create a new worksheet and returns a handle to it.

Parameters

Parameter	Type	Description
`name`	`string`	Name of the new sheet
`rows`	`number`	How may rows would the new sheet have
`column`	`number`	How many columns would the new sheet have

Returns

FWorkbook.deleteActiveSheet

The new created sheet

Example

// The code below creates a new sheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const newSheet = activeSpreadsheet.create('MyNewSheet', 10, 10);

Inherited from

FWorkbook.create

deleteActiveSheet()

deleteActiveSheet(): boolean

Defined in: sheets/src/facade/f-workbook.ts:564

Deletes the currently active sheet.

Returns

boolean

true if the sheet was deleted, false otherwise

Example

// The code below deletes the currently active sheet and stores the new active
// sheet in a variable
const sheet = univerAPI.getActiveWorkbook().deleteActiveSheet();

Inherited from

deleteDefinedName()

deleteDefinedName(name): boolean

Defined in: sheets/src/facade/f-workbook.ts:794

Delete the defined name with the given name.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the defined name to delete

Returns

boolean

true if the defined name was deleted, false otherwise

Example

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

Inherited from

FWorkbook.deleteDefinedName

deleteSheet()

deleteSheet(sheet): boolean

Defined in: sheets/src/facade/f-workbook.ts:363

Deletes the specified worksheet.

Parameters

Parameter	Type	Description
`sheet`	`FWorksheet`	The worksheet to delete.

Returns

boolean

True if the worksheet was deleted, false otherwise.

Example

// The code below deletes the specified worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheet = activeSpreadsheet.getSheetByName('Sheet1');
activeSpreadsheet.deleteSheet(sheet);

Inherited from

FWorkbook.deleteSheet

dispose()

dispose(): void

Defined in: core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

FWorkbook.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

FWorkbook.disposeWithMe

Inherited from

duplicateActiveSheet()

duplicateActiveSheet(): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:600

Duplicates the active sheet.

Returns

FWorkbook.duplicateActiveSheet

The duplicated worksheet

Example

// The code below duplicates the active sheet
 const activeSpreadsheet = univerAPI.getActiveWorkbook();
 activeSpreadsheet.duplicateActiveSheet();

Inherited from

duplicateSheet()

duplicateSheet(sheet): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:581

Duplicates the given worksheet.

Parameters

Parameter	Type	Description
`sheet`	`FWorksheet`	The worksheet to duplicate.

Returns

FWorkbook.duplicateSheet

The duplicated worksheet

Example

// The code below duplicates the given worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();
activeSpreadsheet.duplicateSheet(activeSheet);

Inherited from

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

FWorkbook.ensureNotDisposed

fireEvent()

protected fireEvent<T>(event, params): undefined | boolean

Defined in: sheets/src/facade/f-workbook.ts:92

Fire an event, used in internal only.

Type Parameters

Type Parameter
`T` extends keyof `IEventParamConfig`

Parameters

Parameter	Type	Description
`event`	`T`	{string} key of event
`params`	`IEventParamConfig`[`T`]	{any} params of event

Returns

undefined | boolean

should cancel

Example

this.fireEvent(univerAPI.event.UnitCreated, params);

Inherited from

FWorkbook.fireEvent

getActiveRange()

getActiveRange(): null | FRange

Defined in: sheets/src/facade/f-workbook.ts:543

Returns the selected range in the active sheet, or null if there is no active range.

Returns

null | FRange

the active range

Inherited from

FWorkbook.getActiveRange

getActiveSheet()

getActiveSheet(): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:192

Get the active sheet of the workbook.

Returns

FWorkbook.getActiveSheet

The active sheet of the workbook

Example

// The code below gets the active sheet of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const activeSheet = activeSpreadsheet.getActiveSheet();

Inherited from

getCustomMetadata()

getCustomMetadata(): CustomData

Defined in: sheets/src/facade/f-workbook.ts:915

Get custom metadata of workbook

Returns

CustomData

custom metadata

Example

const fWorkbook = univerAPI.getActiveWorkbook();
const custom = fWorkbook.getCustomMetadata();

Inherited from

FWorkbook.getCustomMetadata

getDefinedName()

getDefinedName(name): null | FDefinedName

Defined in: sheets/src/facade/f-workbook.ts:734

Get the defined name by name.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the defined name to get

Returns

null | FDefinedName

The defined name with the given name

Example

// The code below gets the defined name by name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const definedName = activeSpreadsheet.getDefinedName('MyDefinedName');

Inherited from

FWorkbook.getDefinedName

getDefinedNames()

getDefinedNames(): FDefinedName[]

Defined in: sheets/src/facade/f-workbook.ts:753

Get all the defined names in the workbook.

Returns

FDefinedName[]

All the defined names in the workbook

Example

// The code below gets all the defined names in the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const definedNames = activeSpreadsheet.getDefinedNames();

Inherited from

FWorkbook.getDefinedNames

getId()

getId(): string

Defined in: sheets/src/facade/f-workbook.ts:125

Get the id of the workbook.

Returns

string

The id of the workbook.

Example

// The code below gets the id of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const id = activeSpreadsheet.getId();

Inherited from

FWorkbook.getId

getLocale()

getLocale(): LocaleType

Defined in: sheets/src/facade/f-workbook.ts:629

Get the locale of the workbook.

Returns

LocaleType

The locale of the workbook

Example

// The code below gets the locale of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const locale = activeSpreadsheet.getLocale();

Inherited from

FWorkbook.getLocale

getName()

getName(): string

Defined in: sheets/src/facade/f-workbook.ts:139

Get the name of the workbook.

Returns

string

The name of the workbook.

Example

// The code below gets the name of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const name = activeSpreadsheet.getName();

Inherited from

FWorkbook.getName

getNumSheets()

getNumSheets(): number

Defined in: sheets/src/facade/f-workbook.ts:615

Get the number of sheets in the workbook.

Returns

number

The number of sheets in the workbook

Example

// The code below gets the number of sheets in the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const numSheets = activeSpreadsheet.getNumSheets();

Inherited from

FWorkbook.getNumSheets

getPermission()

getPermission(): FPermission

Defined in: sheets/src/facade/f-workbook.ts:719

Get the PermissionInstance.

Returns

FPermission

The PermissionInstance.

Inherited from

FWorkbook.getPermission

getRegisteredRangeThemes()

getRegisteredRangeThemes(): string[]

Defined in: sheets/src/facade/f-workbook.ts:848

Gets the registered range themes.

Returns

string[]

The name list of registered range themes.

Example

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

Inherited from

FWorkbook.getRegisteredRangeThemes

getSheetByName()

getSheetByName(name): null | FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:283

Get a worksheet by sheet name.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the sheet to get.

Returns

null | FWorksheet

The worksheet with given sheet name

Example

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

Inherited from

FWorkbook.getSheetByName

getSheetBySheetId()

getSheetBySheetId(sheetId): null | FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:263

Get a worksheet by sheet id.

Parameters

Parameter	Type	Description
`sheetId`	`string`	The id of the sheet to get.

Returns

null | FWorksheet

The worksheet with given sheet id

Example

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

Inherited from

FWorkbook.getSheetBySheetId

getSheets()

getSheets(): FWorksheet[]

Defined in: sheets/src/facade/f-workbook.ts:207

Gets all the worksheets in this workbook

Returns

FWorksheet[]

An array of all the worksheets in the workbook

Example

// The code below gets all the worksheets in the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheets = activeSpreadsheet.getSheets();

Inherited from

FWorkbook.getSheets

getSnapshot()

getSnapshot(): IWorkbookData

Defined in: sheets/src/facade/f-workbook.ts:177

Returns

IWorkbookData

{IWorkbookData} Workbook snapshot data

Deprecated

use ‘save’ instead.

Memberof

FWorkbook

Inherited from

FWorkbook.getSnapshot

getUrl()

getUrl(): string

Defined in: sheets/src/facade/f-workbook.ts:667

Get the URL of the workbook.

Returns

string

The URL of the workbook

Example

// The code below gets the URL of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const url = activeSpreadsheet.getUrl();

Inherited from

FWorkbook.getUrl

getWorkbook()

getWorkbook(): Workbook

Defined in: sheets/src/facade/f-workbook.ts:49

Returns

Workbook

Inherited from

FWorkbook.getWorkbook

insertDefinedName()

insertDefinedName(name, formulaOrRefString): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:775

Insert a defined name.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the defined name to insert
`formulaOrRefString`	`string`	The formula(=sum(A2:b10)) or reference(A1) string of the defined name to insert

Returns

FWorkbook.insertDefinedName

The current FWorkbook instance

Example

// The code below inserts a defined name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertDefinedName('MyDefinedName', 'Sheet1!A1');

Inherited from

insertDefinedNameBuilder()

insertDefinedNameBuilder(param): void

Defined in: sheets/src/facade/f-workbook.ts:816

Insert a defined name by builder param.

Parameters

Parameter	Type	Description
`param`	`ISetDefinedNameMutationParam`	The param to insert the defined name

Returns

void

Example

// The code below inserts a defined name by builder param
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const builder = univerAPI.newDefinedName();
const param = builder.setName('MyDefinedName').setRef('Sheet1!A1').build();
activeSpreadsheet.insertDefinedNameBuilder(param);

Inherited from

FWorkbook.insertDefinedNameBuilder

insertSheet()

insertSheet(sheetName?): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:329

Inserts a new worksheet into the workbook. Using a default sheet name. The new sheet becomes the active sheet

Parameters

Parameter	Type	Description
`sheetName`?	`string`	(optional) The name of the new sheet

Returns

FWorkbook.insertSheet

The new sheet

Example

// The code below inserts a new sheet into the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertSheet();
 
// The code below inserts a new sheet into the workbook, using a custom name
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.insertSheet('MyNewSheet');

Inherited from

moveActiveSheet()

moveActiveSheet(index): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:710

Move the active sheet to the specified index.

Parameters

Parameter	Type	Description
`index`	`number`	The index to move the active sheet to

Returns

FWorkbook.moveActiveSheet

This workbook, for chaining

Example

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

Inherited from

moveSheet()

moveSheet(sheet, index): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:684

Move the sheet to the specified index.

Parameters

Parameter	Type	Description
`sheet`	`FWorksheet`	The sheet to move
`index`	`number`	The index to move the sheet to

Returns

This workbook, for chaining

Example

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

Inherited from

FWorkbook.moveSheet

newColor()

newColor(): ColorBuilder

Defined in: sheets-conditional-formatting/src/facade/f-workbook.ts:28

Returns

ColorBuilder

Deprecated

use univerAPI.newColor() as instead.

Implementation of

IFWorkbookConditionalFormattingMixin.newColor

Overrides

FWorkbook.newColor

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Defined in: sheets/src/facade/f-workbook.ts:424

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	the callback.

Returns

FWorkbook.onBeforeCommandExecute

A function to dispose the listening.

Example

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

Inherited from

onCommandExecuted()

onCommandExecuted(callback): IDisposable

Defined in: sheets/src/facade/f-workbook.ts:452

Parameters

Parameter	Type	Description
`callback`	`CommandListener`	the callback.

Returns

A function to dispose the listening.

Example

// The code below registers a callback that will be triggered when a command is invoked targeting the Univer sheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.onCommandExecuted((command) => {
  console.log('Command executed:', command);
});
 
#### Inherited from
 
[`FWorkbook`](../../../sheets/facade/classes/FWorkbook.md).[`onCommandExecuted`](../../../sheets/facade/classes/FWorkbook.md#oncommandexecuted)
 
***
 
### onSelectionChange()
 
```ts
onSelectionChange(callback): IDisposable

Defined in: sheets/src/facade/f-workbook.ts:473

Parameters

Parameter	Type	Description
`callback`	(`selections`) => `void`	The callback.

Returns

FWorkbook.onSelectionChange

A function to dispose the listening

Inherited from

redo()

redo(): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:399

Redo the last undone action.

Returns

FWorkbook.registerRangeTheme

A promise that resolves to true if the redo was successful, false otherwise.

Example

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

Inherited from

FWorkbook.redo

registerRangeTheme()

registerRangeTheme(rangeThemeStyle): void

Defined in: sheets/src/facade/f-workbook.ts:868

Parameters

Parameter	Type
`rangeThemeStyle`	`RangeThemeStyle`

Returns

void

Example

// import {RangeThemeStyle} from '@univerjs/sheets';
const fWorkbook = univerAPI.getActiveWorkbook();
const rangeThemeStyle = new RangeThemeStyle('MyTheme');
rangeThemeStyle.setSecondRowStyle({
   bg: {
      rgb: 'rgb(214,231,241)',
   },
});
fWorkbook.registerRangeTheme(rangeThemeStyle);

Inherited from

save()

save(): IWorkbookData

Defined in: sheets/src/facade/f-workbook.ts:167

Save workbook snapshot data, including conditional formatting, data validation, and other plugin data.

Returns

IWorkbookData

Workbook snapshot data

Example

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

Inherited from

FWorkbook.save

setActiveRange()

setActiveRange(range): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:511

Sets the selection region for active sheet.

Parameters

Parameter	Type	Description
`range`	`FRange`	The range to set as the active selection.

Returns

FWorkbook.setActiveRange

FWorkbook instance

Inherited from

setActiveSheet()

setActiveSheet(sheet): FWorksheet

Defined in: sheets/src/facade/f-workbook.ts:304

Sets the given worksheet to be the active worksheet in the workbook.

Parameters

Parameter	Type	Description
`sheet`	`FWorksheet`	The worksheet to set as the active worksheet.

Returns

FWorkbook.setActiveSheet

The active worksheet

Example

// The code below sets the given worksheet to be the active worksheet
const activeSpreadsheet = univerAPI.getActiveWorkbook();
const sheet = activeSpreadsheet.getSheetByName('Sheet1');
activeSpreadsheet.setActiveSheet(sheet);

Inherited from

setCustomMetadata()

setCustomMetadata(custom): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:901

Set custom metadata of workbook

Parameters

Parameter	Type	Description
`custom`	`CustomData`	custom metadata

Returns

FWorkbook.setCustomMetadata

FWorkbook

Example

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

Inherited from

setEditable()

setEditable(value): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:495

Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.

Parameters

Parameter	Type	Description
`value`	`boolean`	editable value want to set

Returns

FWorkbook.setEditable

FWorkbook instance

Inherited from

setLocale()

setLocale(locale): void

Defined in: sheets/src/facade/f-workbook.ts:637

Parameters

Parameter	Type	Description
`locale`	`LocaleType`	The locale to set

Returns

void

Deprecated

use setSpreadsheetLocale instead.

Inherited from

FWorkbook.setLocale

setName()

setName(name): void

Defined in: sheets/src/facade/f-workbook.ts:153

Set the name of the workbook.

Parameters

Parameter	Type	Description
`name`	`string`	The new name of the workbook.

Returns

void

Example

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

Inherited from

FWorkbook.setName

setSpreadsheetLocale()

setSpreadsheetLocale(locale): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:652

Set the locale of the workbook.

Parameters

Parameter	Type	Description
`locale`	`LocaleType`	The locale to set

Returns

FWorkbook.setSpreadsheetLocale

This workbook, for chaining

Example

// The code below sets the locale of the workbook
const activeSpreadsheet = univerAPI.getActiveWorkbook();
activeSpreadsheet.setLocale(LocaleType.EN_US);

Inherited from

undo()

undo(): FWorkbook

Defined in: sheets/src/facade/f-workbook.ts:383

Undo the last action.

Returns