Class NonVisualTable

Object
   |
   +--Table
         |
         +--NonVisualTable

class NonVisualTable

extends Table

Represents a data table that can be fed with real-time data (delivered by Lightstreamer Server) that are entirely processed and displayed by custom code. The class contains the subscription details and the event handlers needed to process the real-time data.
A NonVisualTable is not associated to a screen table. All the actions that should be triggered by pushed values can only be performed through the event handlers.
Defined in lspushpage.js

Constructor Detail

NonVisualTable

NonVisualTable(<GroupDescriptor> tGroup, <SchemaDescriptor> tSchema, <String> tSubscriptionMode)

Creates an object to be used to describe a data table whose visualization on the page is not managed by Lightstreamer. The object can be supplied to PushPage.addTable() and PushPage.removeTable(), in order to bring the data table to "running" or back to "inactive" state.

Parameters:
tGroup - A group descriptor object, which identifies the items that provide values for the data table rows. An Array of item names or a String group identifier can also be used directly, instead of a group descriptor object.
Note that, in case a GroupListDescriptor or an array is used, a LiteralBasedProvider or equivalent Metadata Adapter is needed on the Server in order to understand the subscription request.
tSchema - A schema descriptor object, which identifies the fields that represent the data table columns. An Array of field names or a String schema identifier can also be used directly, instead of a schema descriptor object.
Note that, in case a SchemaListDescriptor or an array is used, a LiteralBasedProvider or equivalent Metadata Adapter is needed on the Server in order to understand the subscription request.
tSubscriptionMode - the subscription mode for the items, required by Lightstreamer Server. Permitted values are:
• MERGE
• DISTINCT
• RAW
• COMMAND

setCommandLogic

void setCommandLogic(<boolean> enable, <Number> commandPos, <Number> keyPos)

Setter method that configures the "COMMAND logic" behaviour. By enabling the "COMMAND logic" behaviour, it is possible to specify the COMMAND subscription mode and have the underlying data table managed according to the special values of the "key" and "command" fields. In particular, in the received update notifications, the update values will be compared with the previous values with reference to the same key.
If a field name array has been used as schema descriptor for the data table, then the "command" and "key" field should be included in the array. If, however, a schema identifier has been used as schema descriptor, then the positions of these two fields have to be supplied through this method.

Invocation: optional.

Default value: false, i.e. the "COMMAND logic" behaviour is not enabled.

Lifecycle: The "COMMAND logic" behaviour configuration should be done before bringing the data table to "running" state through PushPage.addTable() for the first time.

Parameters:
enable - true/false to enable/disable "COMMAND logic" behaviour.
commandPos - 1-based index of the "command" field. This parameter is optional, but it is mandatory when enable is true and a schema identifier has been used as schema descriptor.
keyPos - 1-based index of the "key" field. This parameter is optional, but it should be supplied if and only if the commandPos parameter is supplied.

See:
- SchemaDescriptor
- UpdateItemInfo