Class: FEventRegistry
Constructors
Constructor
new FEventRegistry(): FEventRegistry;Returns
FEventRegistry
Methods
addEvent()
addEvent<T>(event, callback): IDisposable;Add an event listener
Type Parameters
| Type Parameter |
|---|
T extends keyof IEventParamConfig |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | T | key of event |
callback | (params) => void | callback when event triggered |
Returns
IDisposable
The Disposable instance, for remove the listener
Example
univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {
const { stage } = params;
console.log('life cycle changed', params);
});fireEvent()
fireEvent<T>(event, params): boolean;Fire an event, used in internal only.
Type Parameters
| Type Parameter |
|---|
T extends keyof IEventParamConfig |
Parameters
| Parameter | Type | Description |
|---|---|---|
event | T | key of event |
params | IEventParamConfig[T] | params of event |
Returns
boolean
should cancel
Example
this.fireEvent(univerAPI.Event.LifeCycleChanged, params);registerEventHandler()
registerEventHandler(event, handler): IDisposable;Parameters
| Parameter | Type |
|---|---|
event | string |
handler | () => any |
Returns
IDisposable
removeEvent()
removeEvent<T>(event, callback): void;Type Parameters
| Type Parameter |
|---|
T extends keyof IEventParamConfig |
Parameters
| Parameter | Type |
|---|---|
event | T |
callback | (params) => void |
Returns
void