API Reference › appui-abstract › Utilities › UiEvent

UiEvent<TEventArgs> Class

Deprecated  in 4.2. This type is a duplicate of BeUiEvent, which should be used instead.

iTwin.js UI UiEvent class is a subclass of BeEvent with argument type safety.

Extends

Methods

Name Description
constructor<TEventArgs>(): UiEvent<TEventArgs>    

Inherited methods

Name Inherited from Description
addListener(listener: (args: TEventArgs) => void, scope?: any): () => void BeUiEvent Registers a Listener to be executed whenever this event is raised.
addOnce(listener: (args: TEventArgs) => void, scope?: any): () => void BeUiEvent Registers a callback function to be executed only once when the event is raised.
clear(): void BeUiEvent Clear all Listeners from this BeEvent.
emit(args: TEventArgs): void BeUiEvent Raises event with single strongly typed argument.
has(listener: (args: TEventArgs) => void, scope?: any): boolean BeUiEvent Determine whether this BeEvent has a specified listener registered.
raiseEvent(...args: [args]): void BeUiEvent Raises the event by calling each registered listener with the supplied arguments.
removeListener(listener: (args: TEventArgs) => void, scope?: any): boolean BeUiEvent Un-register a previously registered listener.

Inherited properties

Name Type Inherited from Description
numberOfListeners Accessor ReadOnly number BeUiEvent The number of listeners currently subscribed to the event.

Defined in

Last Updated: 19 April, 2024