| Package | com.lightstreamer.as_client |
| Interface | public interface Table |
| Implementors | NonVisualTable, VisualTable |
| Property | Defined By | ||
|---|---|---|---|
| binary : Boolean [read-only]
The requested encoding for the field values. | Table | ||
| dataAdapter : String
The name of the Data Adapter (within the Adapter Set used by the current session)
that supplies all the items in the Group. | Table | ||
| groupString : String [read-only]
The subscribed group of items, as requested to the Server. | Table | ||
| mode : String [read-only]
The subscription mode for the items. | Table | ||
| requestedBufferSize : *
The length of Lightstreamer Server's buffer for the internal queueing of
updates for each item in the data table.
A queueing buffer is used by the Server to accumulate a burst of updates for an item,
so that they can all be sent to the Client, despite bandwidth or frequency limits. | Table | ||
| requestedMaxFrequency : *
The maximum update frequency to be requested to Lightstreamer Server for all the items in the data table. | Table | ||
| schemaString : String [read-only]
The subscription schema for the items, as requested to the Server. | Table | ||
| selector : String
The selector name for all the items in the data table, or null if no selector is needed.
The selector is a filter on the updates received. | Table | ||
| snapshotRequired : *
Setter method that enables/disables snapshot delivery request
Indicates whether or not to request snapshot delivery for the items in the data table. | Table | ||
| Method | Defined By | ||
|---|---|---|---|
getRangeEnd():uint
Recalls the final index, if a range of items has been set. | Table | ||
getRangeStart():uint
Recalls the starting index, if a range of items has been set. | Table | ||
setItemRange(start:uint, end:uint):void
Setter method that sets a range of items within the specified group. | Table | ||
| binary | property |
binary:Boolean [read-only] The requested encoding for the field values. It can be defined only at object creation.
public function get binary():Boolean| dataAdapter | property |
dataAdapter:String
The name of the Data Adapter (within the Adapter Set used by the current session) that supplies all the items in the Group. If not set, the "DEFAULT" name is used.
The Data Adapter name is configured on the server side through the "name" attribute of the "data_provider" element, in the "adapters.xml" file which defines the Adapter Set. Omitting the attribute configures the "DEFAULT" name.
Note: If more than one Data Adapter is needed to supply all the items in a set of items, then it is not possible to group all the items of the set in a single Table. Multiple tables have to be defined.
public function get dataAdapter():String public function set dataAdapter(value:String):voidSee also
| groupString | property |
groupString:String [read-only] The subscribed group of items, as requested to the Server. The group can be defined only at object creation, as either an Array of item names or a String group identifier.
public function get groupString():String| mode | property |
mode:String [read-only] The subscription mode for the items. It can be defined only at object creation.
public function get mode():String| requestedBufferSize | property |
requestedBufferSize:*
The length of Lightstreamer Server's buffer for the internal queueing of updates for each item in the data table.
A queueing buffer is used by the Server to accumulate a burst of updates for an item, so that they can all be sent to the Client, despite bandwidth or frequency limits. It can be used only when the subscription mode is MERGE or DISTINCT and unfiltered dispatching has not been requested.
Note that the Server may pose an upper limit on the size of its internal buffers. If a 0 value or the string "unlimited" is set, then the buffer length is decided by the Server.
public function get requestedBufferSize():* public function set requestedBufferSize(value:any):void| requestedMaxFrequency | property |
requestedMaxFrequency:*
The maximum update frequency to be requested to Lightstreamer Server for all the items in the data table. It can be used only if the subscription mode is MERGE, DISTINCT or COMMAND (in the latter case, the frequency limitation applies to the UPDATE events for each single key). Note that frequency limits on the items can also be set on the server side and this request can only be issued in order to further reduce the frequency, not to rise it beyond these limits.
This property can also be used to request unfiltered dispatching for the items in the data table, if the string "unfiltered" is set. However, unfiltered dispatching requests may be refused if any frequency limit is posed on the server side for some item. If a 0 value or the string "unlimited" is set, then the update frequency is decided by the Server.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Presto edition; this specific limit also applies to RAW mode and to unfiltered dispatching.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Allegro edition; this specific limit also applies to RAW mode and to unfiltered dispatching.
Edition Note: A further global frequency limit is also imposed by the Server, if it is running in Moderato edition; this specific limit also applies to RAW mode and to unfiltered dispatching.
public function get requestedMaxFrequency():* public function set requestedMaxFrequency(value:any):void| schemaString | property |
schemaString:String [read-only] The subscription schema for the items, as requested to the Server. The schema can be defined only at object creation, as either an Array of field names or a String schema identifier.
public function get schemaString():String| selector | property |
selector:String
The selector name for all the items in the data table, or null if no selector is needed.
The selector is a filter on the updates received. It is executed on the Server and implemented by the Metadata Adapter.
public function get selector():String public function set selector(value:String):void| snapshotRequired | property |
snapshotRequired:*
Setter method that enables/disables snapshot delivery request Indicates whether or not to request snapshot delivery for the items in the data table. The snapshot can be requested only if the subscription mode is MERGE, DISTINCT or COMMAND.
If the subscription mode is DISTINCT, instead of true, it is also possible to supply a number, to specify the requested length (depth) of the snapshot (though the length of the received snapshot may be less than requested, because of insufficient data or server side limits); specifying true means that the snapshot length should be determined only by the Server.
public function get snapshotRequired():* public function set snapshotRequired(value:any):void| getRangeEnd | () | method |
public function getRangeEnd():uintRecalls the final index, if a range of items has been set.
Returnsuint — a 1-based index or 0 if no range has been set.
|
| getRangeStart | () | method |
public function getRangeStart():uintRecalls the starting index, if a range of items has been set.
Returnsuint — a 1-based index or 0 if no range has been set.
|
| setItemRange | () | method |
public function setItemRange(start:uint, end:uint):void
Setter method that sets a range of items within the specified group. Items outside of this range are not subscribed to. The support for ranges allows the front-end to use generic group identifiers as group descriptors, yet being able to subscribe to subsets of such groups or even to single items from such groups, without the need to introduce more specific group identifiers.
Moreover, this method allows for continually resubscribing different item subsets without the need for creating different data table objects.
Parameters
start:uint — 1-based index of the first item in the group that has to be subscribed to.
| |
end:uint — 1-based index of the last item in the group that has to be subscribed to.
|