UiEvent<TEventArgs> Class

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

Extends

  • BeEvent<(args: TEventArgs) => void>

Methods

Name Description
emit(args: TEventArgs): void Calls BeEvent.raiseEvent with type-safe arguments.  

Inherited methods

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

Inherited properties

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

Defined in

Last Updated: 20 September, 2019