FEventRegistry
| packages | @univerjs/core |
|---|
APIs
addEvent
Add an event listener
Signature
addEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): IDisposableParameters
event(T) — key of eventcallback((params: IEventParamConfig[T]) => void) — callback 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)
})fireEvent
Fire an event, used in internal only.
Signature
fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefinedParameters
event(T) — key of eventparams(IEventParamConfig[T]) — params of event
Returns
- (
boolean | undefined) — should cancel
Examples
this.fireEvent(univerAPI.Event.LifeCycleChanged, params)registerEventHandler
Signature
registerEventHandler(event: string, handler: () => IDisposable | Subscription): IDisposableremoveEvent
Signature
removeEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): void