Class Observable<EventSpec>

Tutorial

http://fabricjs.com/fabric-intro-part-2#events

See

Type Parameters

EventSpec

Hierarchy

Observable

Index

Constructors

Properties

__eventListeners

Methods

_removeEventListener fire off on once

Constructors

constructor

new Observable<EventSpec>(): Observable<EventSpec>
Type Parameters
- EventSpec
Returns Observable<EventSpec>

Properties

`Private` __eventListeners

__eventListeners: Record<keyof EventSpec, TEventCallback<any>[]> = ...

Methods

`Private` _removeEventListener

_removeEventListener<K>(eventName, handler?): void
Private
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
- Optional handler: TEventCallback<any>
Returns void
- Defined in src/Observable.ts:98

fire

fire<K>(eventName, options?): void
Fires event with an optional options object
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
  
  Event name to fire
- Optional options: EventSpec[K]
  
  Options object
Returns void
- Defined in src/Observable.ts:159

off

off<K>(eventName, handler): void
unsubscribe an event listener
Type Parameters
- K extends string | number | symbol
Parameters
- eventName: K
  
  event name (eg. 'after:render')
- handler: TEventCallback<any>
  
  event listener to unsubscribe
Returns void
- Defined in src/Observable.ts:120
off(handlers): void
unsubscribe event listeners
Parameters
- handlers: EventRegistryObject<EventSpec>
  
  handlers key/value pairs (eg. {'after:render': handler, 'selection:cleared': handler})
Returns void
- Defined in src/Observable.ts:125
off(): void
unsubscribe all event listeners

Returns void
- Defined in src/Observable.ts:129

on

on<K, E>(eventName, handler): VoidFunction
Observes specified event
Type Parameters
- K extends string | number | symbol
- E
Parameters
- eventName: K
  
  Event name (eg. 'after:render')
- handler: TEventCallback<E>
  
  Function that receives a notification when an event of the specified type occurs
Returns VoidFunction
disposer

Alias
on
- Defined in src/Observable.ts:23
on(handlers): VoidFunction
Parameters
- handlers: EventRegistryObject<EventSpec>
Returns VoidFunction
- Defined in src/Observable.ts:27

once

once<K, E>(eventName, handler): VoidFunction
Observes specified event once
Type Parameters
- K extends string | number | symbol
- E
Parameters
- eventName: K
  
  Event name (eg. 'after:render')
- handler: TEventCallback<E>
  
  Function that receives a notification when an event of the specified type occurs
Returns VoidFunction
disposer

Alias
once
- Defined in src/Observable.ts:62
once(handlers): VoidFunction
Parameters
- handlers: EventRegistryObject<EventSpec>
Returns VoidFunction
- Defined in src/Observable.ts:66

Generated using TypeDoc