Class TcSymbolEvent

Derived class for narrowing down event source. Class that represents all the TcEvents emitted by the TcSymbols through the TcBindings

Hierarchy

TcEvent
- TcSymbolEvent

Index

Constructors

constructor

Accessors

Methods

stopPropagation

Constructors

constructor

new TcSymbolEvent(context: TcContext, symbol: TcSymbol, data?: any): TcSymbolEvent

Overrides TcEvent.constructor
- Defined in src/tc-event.ts:179
Construct the TcSymbolEvent, which represents an event emitted from a TcSymbol Object

Parameters
- context: TcContext
  
  The TcContext, from which this event originated
- symbol: TcSymbol
  
  The TcSymbol, from which this event originated
- Optional data: any
  
  Any data associated with this event
Returns TcSymbolEvent

Accessors

context

get context(): TcContext

Inherited from TcEvent.context
- Defined in src/tc-event.ts:109
Access the TcContext of this event

Returns TcContext

data

get data(): any | undefined

Inherited from TcEvent.data
- Defined in src/tc-event.ts:114
Access any Data, which is associated with the event

Returns any | undefined

propagationStopped

get propagationStopped(): boolean

Inherited from TcEvent.propagationStopped
- Defined in src/tc-event.ts:129
Is true if Event Propagation was stopped

Returns boolean

symbol

get symbol(): TcSymbol

- Defined in src/tc-event.ts:196
Access the TcSymbol, which emitted this event

Returns TcSymbol

timestamp

get timestamp(): number

Inherited from TcEvent.timestamp
- Defined in src/tc-event.ts:119
Access the Timestamp of event creation

Returns number

Methods

stopPropagation

stopPropagation(): void

Inherited from TcEvent.stopPropagation
- Defined in src/tc-event.ts:124
Stop the propagation of the event, up the TcEmitter tree

Returns void

Generated using TypeDoc