@univerjs/sheets v0.5.4


Interface: IFSheetEventMixin

Defined in: submodules/univer/packages/sheets/src/facade/f-event.ts:22

Accessors

BeforeSheetCreate

Get Signature

get BeforeSheetCreate(): "BeforeSheetCreate"

Defined in: submodules/univer/packages/sheets/src/facade/f-event.ts:46

Event fired before a sheet is created

See

IBeforeSheetCreateEventParams

Example
univerAPI.addEvent(univerAPI.event.BeforeSheetCreate, (params) => {
     const { workbook, index, sheet } = params;
    console.log('unit created', params);
});
Returns

"BeforeSheetCreate"


SheetCreated

Get Signature

get SheetCreated(): "SheetCreated"

Defined in: submodules/univer/packages/sheets/src/facade/f-event.ts:34

Event fired after a sheet is created

See

ISheetCreatedEventParams

Example
univerAPI.addEvent(univerAPI.event.SheetCreated, (params) => {
     const { workbook, worksheet } = params;
    console.log('unit created', params);
});
Returns

"SheetCreated"


WorkbookCreated

Get Signature

get WorkbookCreated(): "WorkbookCreated"

Defined in: submodules/univer/packages/sheets/src/facade/f-event.ts:58

Event fired after a workbook is created

See

IWorkbookCreateParam

Example
univerAPI.addEvent(univerAPI.event.WorkbookCreated, (params) => {
     const { unitId, type, workbook, unit } = params;
    console.log('unit created', params);
});
Returns

"WorkbookCreated"


WorkbookDisposed

Get Signature

get WorkbookDisposed(): "WorkbookDisposed"

Defined in: submodules/univer/packages/sheets/src/facade/f-event.ts:70

Event fired after a workbook is disposed

See

IWorkbookDisposedEvent

Example
univerAPI.addEvent(univerAPI.event.WorkbookDisposed, (params) => {
     const { unitId, unitType, snapshot } = params;
    console.log('unit disposed', params);
});
Returns

"WorkbookDisposed"