Constructor
new module:caplin/chart/series/SeriesRequest(config)
Constructs a new
caplin.chart.series.SeriesRequest
object from a map of configuration properties.
Parameters:
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
Map | The configuration properties for the request object.
Properties
|
Members
-
(static) REQUEST_BOTH :String
-
Request both historic and real-time chart series data.
Type:
- String
-
(static) REQUEST_HISTORIC :String
-
Request historic chart series data.
Type:
- String
-
(static) REQUEST_REALTIME :String
-
Request real-time chart series data.
Type:
- String
Methods
-
(static) deserialize(xml) → {module:caplin/chart/series/SeriesRequest}
-
Creates a new instance of
module:caplin/chart/series/SeriesRequest
based on the values in the serialised XML.Parameters:
Name Type Description xml
Element A XML element representing the state of the module:caplin/chart/series/SeriesRequest
object.Returns:
The deserialised instance. -
(static) isValidRequestType(requestType) → {Boolean}
-
Checks if
requestType
is valid. Valid request types are:-
module:caplin/chart/series/SeriesRequest.REQUEST_HISTORIC
-module:caplin/chart/series/SeriesRequest.REQUEST_REALTIME
-module:caplin/chart/series/SeriesRequest.REQUEST_BOTH
Parameters:
Name Type Description requestType
String The request type to check. Returns:
Returnstrue
if the passed request type is valid,false
otherwise.- Type
- Boolean
-
getBegin() → {String}
-
Returns the Unix time-stamp that indicates how far back historic data should be requested.
Returns:
The string representation of the time-stamp.- Type
- String
-
getCreationTimestamp() → {Number}
-
Returns:
The series creation timestamp (milliseconds).- Type
- Number
-
getDisplayName() → {String}
-
Returns:
The display name for the series.- Type
- String
-
getEnd() → {String}
-
Returns the Unix time-stamp that indicates the point in time up until which historic data should be requested.
Returns:
The string representation of the time-stamp.- Type
- String
-
getId() → {String}
-
Returns the unique identifier for this request.
Returns:
The request id.- Type
- String
-
getInstrument() → {String}
-
Returns the instrument that this request relates to.
Returns:
The instrument for this request.- Type
- String
-
getInterval() → {String}
-
Returns the interval to be requested.
Returns:
The interval to be requested.- Type
- String
-
getSeriesType() → {String}
-
Returns the series type required for the request.
Returns:
The series type.- Type
- String
-
getTimeout() → {Number}
-
Returns the timeout (in milliseconds) for this request.
Returns:
The timeout in milliseconds.- Type
- Number
-
getType() → {String}
-
Returns the type of this request. Possible return values:
module:caplin/chart/series/SeriesRequest.REQUEST_HISTORIC
,module:caplin/chart/series/SeriesRequest.REQUEST_REALTIME
ormodule:caplin/chart/series/SeriesRequest.REQUEST_BOTH
.Returns:
- Type
- String
-
isIntraperiod() → {Boolean}
-
Returns
true
if this is a intraperiod request,false
otherwise..Returns:
- Type
- Boolean
-
serialize() → {String}
-
Returns the serialised representation of the
Request
object, which can be later used to recreate the object (usingmodule:caplin/chart/series/SeriesRequest.deserialize
).Returns:
The XML representation of the object.- Type
- String