Methods
onVisualUpdate(key, visualUpdate, position)
Event handler that is called by Lightstreamer each time a row of the
underlying model is added or modified and the change is going to be
applied to the corresponding cells in the grid.
By implementing this method, it is possible to perform custom
formatting on the field values, to set the cell stylesheets and to
control the display policy.
In addition, through a custom handler it is possible to perform custom
display actions for the row.
Note that the availability of cells currently associated to the row
fields depends on how the StaticGrid was configured.
This event is also fired when a row is removed from the model,
to allow clearing actions related to custom display actions previously
performed for the row. Row removal may happen when the StaticGrid
is listening to events from Subscription instance(s), and the first
Subscription it listens to is a COMMAND or a DISTINCT Subscription;
removal may also happen in case of AbstractWidget#removeRow or
AbstractWidget#clean execution.
On the other hand, in case the row is just repositioned on the grid
no notification is supplied, but the formatting and style are kept for
the new cells.
This event is fired before the update is applied to both the HTML cells
of the grid and the internal model. As a consequence, through
AbstractWidget#updateRow it is still possible to modify the current update.
Parameters:
Name | Type | Description |
---|---|---|
key |
String |
the key associated with the row that is being added/removed/updated (keys are described in AbstractWidget). |
visualUpdate |
VisualUpdate |
a value object containing the
updated values for all the cells, together with their display settings.
The desired settings can be set in the object, to substitute the default
settings, before returning.
|
position |
String |
the value of the data-row or data-item value of the cells targeted by this update. |