Class: FSheetSortEventName

Defined in: sheets-sort/src/facade/f-event.ts:54

Extends

FEventName

Implements

IFSheetSortEventMixin

Constructors

new FSheetSortEventName()

new FSheetSortEventName(): FSheetSortEventName

Defined in: core/src/facade/f-event.ts:114

Returns

FSheetSortEventName

Inherited from

FEventName.constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from	Defined in
`SheetBeforeRangeSort`	`readonly`	`"SheetBeforeRangeSort"`	This event will be emitted before sorting a range on a worksheet. Type of the event is ISheetRangeSortParams. Example `const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeSort, (params) => { const { workbook, worksheet, sortColumn } = params; sortColumn.forEach((col) => { console.log(col.column, col.ascending); }); });`	`IFSheetSortEventMixin`.`SheetBeforeRangeSort` `FEventName.SheetBeforeRangeSort`	-	sheets-sort/src/facade/f-event.ts:56
`SheetRangeSorted`	`readonly`	`"SheetRangeSorted"`	This event will be emitted when a range on a worksheet is sorted. Type of the event is ISheetRangeSortedParams. Example `const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeSorted, (params) => { const { workbook, worksheet, sortColumn } = params; sortColumn.forEach((col) => { console.log(col.column, col.ascending); }); });`	`IFSheetSortEventMixin`.`SheetRangeSorted` `FEventName.SheetRangeSorted`	-	sheets-sort/src/facade/f-event.ts:55
`_instance`	`static`	`null` \| `FEventName`	-	-	`FEventName`.`_instance`	core/src/facade/f-event.ts:87

Accessors

BeforeCommandExecute

Get Signature

get BeforeCommandExecute(): "BeforeCommandExecute"

Defined in: 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"

Inherited from

FEventName.BeforeCommandExecute

BeforeRedo

Get Signature

get BeforeRedo(): "BeforeRedo"

Defined in: 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"

Inherited from

FEventName.BeforeRedo

BeforeSheetCreate

Get Signature

get BeforeSheetCreate(): "BeforeSheetCreate"

Defined in: 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"

Inherited from

FEventName.BeforeSheetCreate

BeforeUndo

Get Signature

get BeforeUndo(): "BeforeUndo"

Defined in: 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"

Inherited from

FEventName.BeforeUndo

CommandExecuted

Get Signature

get CommandExecuted(): "CommandExecuted"

Defined in: 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"

Inherited from

FEventName.CommandExecuted

DocCreated

Get Signature

get DocCreated(): "DocCreated"

Defined in: 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"

Inherited from

FEventName.DocCreated

DocDisposed

Get Signature

get DocDisposed(): "DocDisposed"

Defined in: 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"

Inherited from

FEventName.DocDisposed

LifeCycleChanged

Get Signature

get LifeCycleChanged(): "LifeCycleChanged"

Defined in: 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"

Inherited from

FEventName.LifeCycleChanged

Redo

Get Signature

get Redo(): "Redo"

Defined in: 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"

Inherited from

FEventName.Redo

SheetCreated

Get Signature

get SheetCreated(): "SheetCreated"

Defined in: 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"

Inherited from

FEventName.SheetCreated

Undo

Get Signature

get Undo(): "Undo"

Defined in: 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"

Inherited from

FEventName.Undo

WorkbookCreated

Get Signature

get WorkbookCreated(): "WorkbookCreated"

Defined in: 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"

Inherited from

FEventName.WorkbookCreated

WorkbookDisposed

Get Signature

get WorkbookDisposed(): "WorkbookDisposed"

Defined in: 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);
});