Home | Class Index

SDK Version: 3.5.1-269053

Documentation generated on 03 September 2013

Class
caplin.chart.series.request

CaplinPlatform

The class is still an Alpha release. It should only be used for experimental development as substantial changes may occur.
Represents a request to be made for an OHLC(V) (open-high-low-close-volume) chart series. A CaplinPlatform object can be passed through to caplin.chart.Series's subscribe method in order to request a new OHLC(V) series.

Constructor Summary

Attributes Name and Description
caplin.chart.series.request.CaplinPlatform(Map mConfig)

Constructs a new caplin.chart.series.request.CaplinPlatform.

Method Summary

Attributes Name and Description
<static> void createFromSerializedState( eXml)

Instantiates CaplinPlatform objects from the XML representation of state.
void getBegin()

void getEnd()

void getId()

void getInstrument()

void getInterval()

void getSerializedState()

Returns the serialized state of this caplin.chart.series.request.CaplinPlatform object in the form of an XML string.
void getSeriesType()

Constructor Detail

► caplin.chart.series.request.CaplinPlatform(Map mConfig)

Constructs a new caplin.chart.series.request.CaplinPlatform.

Configuration should contain the following fields:

nameoptionaldefaultdescription
instrument no The currency pair for which you wish to request chart series data
seriesType yes BidOffer BidOffer or Other depending on which series the chart is to render.
interval yes 1m Tick interval. Possible values are configured on the backend.
type yes caplin.chart.series.Request.REQUEST_HISTORIC Te type of data you wish to request (historic, realtime, both). See caplin.chart.series.Request for more details.
begin yes Only used if requesting historic data. Used to determine the beginning date of the data you wish to request.
end yes Only used if requesting historic data. Used to determine the end date of the data you wish to request.
object from a map of configuration properties.

Parameters
Map mConfig The configuration properties for the request object.

Method Detail

► <static> void createFromSerializedState( eXml)

Instantiates CaplinPlatform objects from the XML representation of state.

Parameters
eXml
See
caplin.chart.series.Request.createFromSerializedState

► void getBegin()

See
caplin.chart.series.Request#getBegin

► void getEnd()

See
caplin.chart.series.Request#getEnd

► void getId()

See
caplin.chart.series.Request#getId

► void getInstrument()

See
caplin.chart.series.Request#getInstrument

► void getInterval()

See
caplin.chart.series.Request#getInterval

► void getSerializedState()

Returns the serialized state of this caplin.chart.series.request.CaplinPlatform object in the form of an XML string.

See
caplin.chart.series.Request#getSerializedState

► void getSeriesType()

See
caplin.chart.series.Request#getSeriesType