HTML Client 5.0.1

Class ChartLine

Object
   |
   +--ChartLine

class ChartLine


A line to be displayed in a multiline chart. ChartLine instances can be supplied to ChartTable.addLine() on a ChartTable instance in order to add lines. A ChartLine instance specifies the item and field in the ChartTable data table whose updates supply the line point Y-coordinate values. The related X-coordinate values are determined for each update by the ChartTable.
A ChartLine object instance can only be added to a ChartTable instance once.
Defined in lspushpage.js


Constructor Summary
ChartLine ()
            Creates an object to be used to describe a single line of a multiline chart.
 
Method Summary
 void onYOverflow(<Number> lastY, <Number> minY, <Number> maxY)
           Event handler that is called when a new update has been received such that a new point for this line has to be added to the chart, but cannot be shown because its Y-coordinate value is higher than the upper limit set for the Y axis on this line, or lower than the lower limit.
 void positionYAxis(<Number> min, <Number> max)
           Operation method that sets or changes the limits for the visible part of the Y axis of the chart (that is, the minimum and maximum y-coordinates shown in the chart, relative to this line).
 void setLineClass(<String> lClass)
           Setter method that sets the stylesheet to be applied to the segments drawn on the chart area.
 void setPointClass(<String> pClass)
           Setter method that sets the stylesheet to be applied to the points drawn on the chart area.
 void setYAxis(<ItemDescriptor> item, <FieldDescriptor> field, <boolean> commaAsDecimalSeparator)
           Setter method that sets the field of the data table to be used as the source of the Y-coordinate values of the line.
 void setYLabels(<Number> labelsNum, <String> labelsClass, <LabelFormatter> labelsFormatter)
           Setter method that configures the legend for the Y axis relative to this line.

Constructor Detail

ChartLine

ChartLine()

Method Detail

onYOverflow

void onYOverflow(<Number> lastY, <Number> minY, <Number> maxY)

positionYAxis

void positionYAxis(<Number> min, <Number> max)

setLineClass

void setLineClass(<String> lClass)

setPointClass

void setPointClass(<String> pClass)

setYAxis

void setYAxis(<ItemDescriptor> item, <FieldDescriptor> field, <boolean> commaAsDecimalSeparator)

setYLabels

void setYLabels(<Number> labelsNum, <String> labelsClass, <LabelFormatter> labelsFormatter)

HTML Client 5.0.1

Lightstreamer HTML Client API
Documentation generated by JSDoc on Tue May 22 11:46:54 2012