@univerjs/sheets-filter v0.5.4


Class: FSheetFilterEventName

Defined in: sheets-filter/src/facade/f-event.ts:79

Extends

Implements

Constructors

new FSheetFilterEventName()

new FSheetFilterEventName(): FSheetFilterEventName

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

Returns

FSheetFilterEventName

Inherited from

FEventName.constructor

Properties

PropertyModifierTypeInherited fromDefined in
_instancestaticnull | FEventNameFEventName._instancecore/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


SheetBeforeRangeFilter

Get Signature

get SheetBeforeRangeFilter(): "SheetBeforeRangeFilter"

Defined in: sheets-filter/src/facade/f-event.ts:80

This event will be emitted before the filter criteria on a column is changed. Type of the event is ISheetRangeFilteredParams.

Example
const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilter, (params) => {
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
});
Returns

"SheetBeforeRangeFilter"

This event will be emitted before the filter criteria on a column is changed. Type of the event is ISheetRangeFilteredParams.

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilter, (params) => {
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
});

Implementation of

IFSheetFilterEventMixin.SheetBeforeRangeFilter

Overrides

FEventName.SheetBeforeRangeFilter

SheetBeforeRangeFilterClear

Get Signature

get SheetBeforeRangeFilterClear(): "SheetBeforeRangeFilterClear"

Defined in: sheets-filter/src/facade/f-event.ts:83

This event will be emitted after the filter on a worksheet is cleared. Type of the event is ISheetRangeFilterClearedEventParams.

Example
const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilterClear, (params) => {
  const { workbook, worksheet } = params;
 
  // your custom logic
});
Returns

"SheetBeforeRangeFilterClear"

This event will be emitted after the filter on a worksheet is cleared. Type of the event is ISheetRangeFilterClearedEventParams.

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetBeforeRangeFilterClear, (params) => {
  const { workbook, worksheet } = params;
 
  // your custom logic
});

Implementation of

IFSheetFilterEventMixin.SheetBeforeRangeFilterClear

Overrides

FEventName.SheetBeforeRangeFilterClear

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

SheetRangeFilterCleared

Get Signature

get SheetRangeFilterCleared(): "SheetRangeFilterCleared"

Defined in: sheets-filter/src/facade/f-event.ts:82

This event will be emitted when the filter on a worksheet is cleared. Type of the event is ISheetRangeFilterClearedEventParams.

Example
const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFilterCleared, (params) => {
  const { workbook, worksheet } = params;
 
  // your custom logic
});
Returns

"SheetRangeFilterCleared"

This event will be emitted when the filter on a worksheet is cleared. Type of the event is ISheetRangeFilterClearedEventParams.

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFilterCleared, (params) => {
  const { workbook, worksheet } = params;
 
  // your custom logic
});

Implementation of

IFSheetFilterEventMixin.SheetRangeFilterCleared

Overrides

FEventName.SheetRangeFilterCleared

SheetRangeFiltered

Get Signature

get SheetRangeFiltered(): "SheetRangeFiltered"

Defined in: sheets-filter/src/facade/f-event.ts:81

This event will be emitted when the filter criteria on a column is changed. Type of the event is ISheetRangeFilteredParams.

Example
const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFiltered, (params) => {
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
});
Returns

"SheetRangeFiltered"

This event will be emitted when the filter criteria on a column is changed. Type of the event is ISheetRangeFilteredParams.

Example

const callbackDisposable = univerAPI.addEvent(univerAPI.Event.SheetRangeFiltered, (params) => {
  const { workbook, worksheet, col, criteria } = params;
 
  // your custom logic
});

Implementation of

IFSheetFilterEventMixin.SheetRangeFiltered

Overrides

FEventName.SheetRangeFiltered

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);
});
Returns

"WorkbookDisposed"

Inherited from

FEventName.WorkbookDisposed

Methods

extend()

static extend(source): void

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

Parameters

ParameterType
sourceany

Returns

void

Inherited from

FEventName.extend


get()

static get(): FEventName

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

Returns

FEventName

Inherited from

FEventName.get