Caplin Trader 5.1.0

Class: module:ct-watchlist/sljs/WatchlistGridDataProvider

module:ct-watchlist/sljs/WatchlistGridDataProvider()

A grid data provider for watchlists that wraps module:ct-grid/dataprovider/sljs/SLJSContainerDataProvider. This data provider is for meant for use with watchlists persisted through transformer.

Constructor

new module:ct-watchlist/sljs/WatchlistGridDataProvider()

Methods

addRow(subject, indexopt)

Add a row to this watchlist grid.

Parameters:
Name Type Attributes Description
subject String

The RTTP subject name of the instrument to add.
index number <optional>

The index to insert the new objects at. If not included, objects will be appended to the end of the watchlist.

addRows(subjects, indexopt)

Add a number of rows to this watchlist grid.

Parameters:
Name Type Attributes Description
subjects Array

The RTTP subject names of the instruments to add.
index number <optional>

The index to insert the new objects at. If not included, objects will be appended to the end of the watchlist.

canReceive()

See:

canReceiveMultipleObjects()

See:

canReceiveObjects()

See:

configureDataProvider(xmlConfigurationNode, isDataProviderDefinedByParent)

Extract the watchlist ID from the provided xml node. Create a new xml configuration node with the subject obtained from the watchlist service and pass that on to the underlying data provider's configureDataProvider() method

Parameters:
Name Type Description
xmlConfigurationNode Element

Access to the XML node that contains any configuration information the data provider needs to configure itself.
isDataProviderDefinedByParent boolean

Informs the data provider whether its configuration came via inheritance, or was configured locally — this will affect how the data provider should behave when its module:ct-grid/GridDataProvider#getSerializedState method is invoked.
See:

getLastReceiveFailureMessage()

See:

getSuccessMessage()

See:

onOpen(width, height)

Called when the view is opened.

Parameters:
Name Type Description
width int

the width of the grid.
height int

the height of the grid.
See:

receiveObjects()

See:

removeRow(subject)

Remove a row from this watchlist grid.

Parameters:
Name Type Description
subject String

The RTTP subject name of the instrument to remove.

removeRows(subjects)

Remove a number of rows from this watchlist grid.

Parameters:
Name Type Description
subjects Array

An array of RTTP subject names of the instruments to remove.

resumeUpdates()

See:

setGridView()

See:

terminateUpdates()

See: