@univerjs/core v0.5.4

Class: FEventName

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:86

Extended by

• FSheetEventName
• FDrawingEventNameMixin
• FSheetFilterEventName
• FSheetSortEventName
• FCommentEvent
• FSheetsUIEventName
• FPivotTableEvent

Constructors

new FEventName()

new FEventName(): FEventName

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:114

Returns

FEventName

Properties

Accessors

BeforeCommandExecute

Get Signature

get BeforeCommandExecute(): "BeforeCommandExecute"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:252

Event fired before a command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.BeforeCommandExecute, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"BeforeCommandExecute"

BeforeRedo

Get Signature

get BeforeRedo(): "BeforeRedo"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:207

Event fired before a redo command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.BeforeRedo, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"BeforeRedo"

BeforeUndo

Get Signature

get BeforeUndo(): "BeforeUndo"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:222

Event fired before an undo command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.BeforeUndo, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"BeforeUndo"

CommandExecuted

Get Signature

get CommandExecuted(): "CommandExecuted"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:237

Event fired when a command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.CommandExecuted, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"CommandExecuted"

DocCreated

Get Signature

get DocCreated(): "DocCreated"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:132

Event fired when a document is created

See

IDocCreatedParam

Example

univerAPI.addEvent(univerAPI.event.DocCreated, (params) => {
    const { unitId, type, doc, unit } = params;
    console.log('doc created', params);
});

Returns

"DocCreated"

DocDisposed

Get Signature

get DocDisposed(): "DocDisposed"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:147

Event fired when a document is disposed

See

IDocDisposedEvent

Example

univerAPI.addEvent(univerAPI.event.DocDisposed, (params) => {
    const { unitId, unitType, snapshot } = params;
    console.log('doc disposed', params);
});

Returns

"DocDisposed"

LifeCycleChanged

Get Signature

get LifeCycleChanged(): "LifeCycleChanged"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:162

Event fired when life cycle is changed

See

ILifeCycleChangedEvent

Example

univerAPI.addEvent(univerAPI.event.LifeCycleChanged, (params) => {
     const { stage } = params;
    console.log('life cycle changed', params);
});

Returns

"LifeCycleChanged"

Redo

Get Signature

get Redo(): "Redo"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:177

Event fired when a redo command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.Redo, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"Redo"

Undo

Get Signature

get Undo(): "Undo"

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:192

Event fired when an undo command is executed

See

ICommandEvent

Example

univerAPI.addEvent(univerAPI.event.Undo, (event) => {
    const { params, id, type } = event;
    console.log('command executed', event);
});

Returns

"Undo"

Methods

extend()

static extend(source): void

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:98

Parameters

Returns

void

get()

static get(): FEventName

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/core/src/facade/f-event.ts:88

Returns

FEventName