Class Events

All cluster behaviors support interaction events in addition to cluster-specific attribute mutation events.

Hierarchy (view full)

EventEmitter
- Events

Index

Constructors

Properties

interactionBegin interactionEnd

Accessors

Methods

[dispose] addListener emit removeListener

Constructors

constructor

new Events(): Events
Returns Events
Inherited from EventEmitter.constructor

Properties

interactionBegin

interactionBegin: Observable<[], void> = ...

Emitted when state associated with this behavior is first mutated by a specific interaction.

interactionEnd

interactionEnd: AsyncObservable<[], void> = ...

Emitted when a mutating interaction completes.

Accessors

eventNames

get eventNames(): string[]
Returns string[]
Inherited from EventEmitter.eventNames
- Defined in packages/general/dist/esm/util/Observable.d.ts:129

Methods

[dispose]

[dispose](): void
Returns void
Inherited from EventEmitter.[dispose]
- Defined in packages/general/dist/esm/util/Observable.d.ts:130

addListener

addListener<This, N>(this, name, handler): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- handler: ObserverOf<This, N>
Returns void
Inherited from EventEmitter.addListener
- Defined in packages/general/dist/esm/util/Observable.d.ts:127

emit

emit<This, N>(this, name, ...payload): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- Rest...payload: PayloadOf<This, N>
Returns void
Inherited from EventEmitter.emit
- Defined in packages/general/dist/esm/util/Observable.d.ts:126

removeListener

removeListener<This, N>(this, name, handler): void
Type Parameters
- This
- N extends string
Parameters
- this: This
- name: N
- handler: ObserverOf<This, N>
Returns void
Inherited from EventEmitter.removeListener
- Defined in packages/general/dist/esm/util/Observable.d.ts:128