UiEvent<TEventArgs> Class
iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.
Extends
- BeUiEvent<TEventArgs>
Methods
| Name | Description | |
|---|---|---|
| constructor<TEventArgs>(): UiEvent<TEventArgs> |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| addListener(listener: (args: TEventArgs) => void, scope?: any): () => void Inherited | BeUiEvent | Registers a Listener to be executed whenever this event is raised. |
| addOnce(listener: (args: TEventArgs) => void, scope?: any): () => void Inherited | BeUiEvent | Registers a callback function to be executed only once when the event is raised. |
| clear(): void Inherited | BeUiEvent | Clear all Listeners from this BeEvent. |
| emit(args: TEventArgs): void Inherited | BeUiEvent | Raises event with single strongly typed argument. |
| has(listener: (args: TEventArgs) => void, scope?: any): boolean Inherited | BeUiEvent | Determine whether this BeEvent has a specified listener registered. |
| raiseEvent(...args: [args]): void Inherited | BeUiEvent | Raises the event by calling each registered listener with the supplied arguments. |
| removeListener(listener: (args: TEventArgs) => void, scope?: any): boolean Inherited | BeUiEvent | Un-register a previously registered listener. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| numberOfListeners Accessor Inherited ReadOnly | number | BeUiEvent | The number of listeners currently subscribed to the event. |
Defined in
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.