Class Notification

A single subscription

Index

Constructors

Methods

add publish remove

Constructors

constructor

new Notification(fnMap?: FunctionMap): Notification
Parameters
- fnMap: FunctionMap = ...
  Only needed for Recorder.
Returns Notification
- Defined in src/js/tools/tools.ts:1117

Methods

add

add(callback: string | (() => void), numberOfPublications?: number): number
Add a subscriber to an event.
Parameters
- callback: string | (() => void)
  to be called when events are published. If string, then FunctionMap of the Figure or FigureElement to which the notification manager is a property of will be used.
- numberOfPublications: number = -1
Returns number
subscirber id
- Defined in src/js/tools/tools.ts:1142

publish

publish(functionArgument?: any, asArray?: boolean): void
Publish to all subscribers
Parameters
- functionArgument: any = undefined
  argument to pass to subscriber callback
- asArray: boolean = true
Returns void
- Defined in src/js/tools/tools.ts:1157

remove

remove(subscirberId: string | number): void
Remove subscriber - the subscirber id is returned by this object's add method
Parameters
- subscirberId: string | number
Returns void
- Defined in src/js/tools/tools.ts:1187