Caplin Trader 4.8.0

Class: module:caplin/element/renderer/MultiStreamRenderer

module:caplin/element/renderer/MultiStreamRenderer

Constructor

new module:caplin/element/renderer/MultiStreamRenderer()

A multi stream renderer.
Extends:

Extends

Methods

bindHandlers()

Binds event listeners to the control for all the handlers, which will result in a callbacks to the onRendererEvent() method then any event occurs.
Inherited From:

getControl() → {module:caplin/control/Control}

Returns a control corresponding to the renderer.
Inherited From:
Returns:
The control
Type
module:caplin/control/Control

getValue()

Gets the renderer value.
Inherited From:
Returns:
vRendererValue The renderer value.

getVariable(variableName) → {String}

Gets the renderer's variable.
Parameters:
Name Type Description
variableName String The variable name to retrieve.
Inherited From:
Returns:
The variable value
Type
String

isEnabled() → {boolean}

Determines whether the control is enabled.
Inherited From:
Returns:
if the control is enabled.
Type
boolean

onRendererEvent(domEvent)

Event handler callback function that receives the events attached to the controls and defined in the handlers.

All control events call this function.

Parameters:
Name Type Description
domEvent object The DOM event that was fired
Inherited From:

refresh()

Apply all pending updates
Inherited From:

resetUnformattedStreamValue()

Creates a null value for this renderer type
Inherited From:

setSerialId(serialId)

Sets the serial id.
Parameters:
Name Type Description
serialId int The serial id
Inherited From:

setValue(vRendererValue)

Sets the renderer value.
Parameters:
Name Type Description
vRendererValue Variant The renderer value.
Inherited From:

toString() → {string}

Returns a human-readable string representation of the object, which is useful for debugging.
Returns:
The string representation
Type
string

unbindHandlers()

Unbinds event listeners from the control for all the handlers.
Inherited From:

updateFieldValues(fieldValues)

Updates the field values.
Parameters:
Name Type Description
fieldValues Map The field values.
Inherited From:

updateStreamValues(fieldValues)

Parameters:
Name Type Description
fieldValues Map