Events

Overview

@univerjs/core

@univerjs-pro/sheets-pivot

APIs

Lifecycle & Creation

addEvent

Add an event listener

Signature

addEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): IDisposable

Parameters

• event T — No description
• callback (params: IEventParamConfig[T]) => void — when event triggered

Returns

• IDisposable — The Disposable instance, for remove the listener

Examples

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

Getters & Queries

get

Signature

static get(): FEventName

Returns

• FEventName — See signature above.

Actions & Operations

removeEvent

Signature

removeEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): void

Parameters

• event T — No description
• callback (params: IEventParamConfig[T]) => void — No description

Events

fireEvent

Fire an event, used in internal only.

Signature

fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefined

Parameters

• event T — No description
• params IEventParamConfig[T] — of event

Returns

• boolean — should cancel

Examples

this.fireEvent(univerAPI.Event.LifeCycleChanged, params);

registerEventHandler

Signature

registerEventHandler(event: string, handler: () => IDisposable | Subscription): IDisposable

Parameters

• event string — No description
• handler () => any — No description

Returns

• IDisposable — See signature above.

Miscellaneous

extend

Signature

static extend(source: any): void

Parameters

• source any — No description

generatePivotTable

Signature

generatePivotTable<T extends DataFieldManager>(data: IDataFieldDataArray, CustomDataFieldManager?: new (...args: unknown[]) => T): FGenericPivotTable

Parameters

• data [string[], ...(IDataFieldValue & Date)[][]] — No description
• CustomDataFieldManager new (...args: unknown[]) => T (optional) — No description

Returns

• FGenericPivotTable — See signature above.