|
HTML Client 5.0.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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()
Method Detail |
void onYOverflow(<Number> lastY, <Number> minY, <Number> maxY)
lastY
- The Y-coordinate value of the new point to be shown on the chart and that exceeds the current upper or lower limit.
minY
- The current lower limit for the visible part of the Y axis.
maxY
- The current upper limit for the visible part of the Y axis.
void positionYAxis(<Number> min, <Number> max)
min
- lower limit for the visible part of the Y axis.
max
- higher limit for the visible part of the Y axis.
void setLineClass(<String> lClass)
lClass
- the name of an existing stylesheet.
void setPointClass(<String> pClass)
pClass
- the name of an existing stylesheet.
void setYAxis(<ItemDescriptor> item, <FieldDescriptor> field, <boolean> commaAsDecimalSeparator)
item
- an item descriptor object for the item whose updates supply the line points. A String item name or a Number representing an item position can also be used directly, instead of an item descriptor object.
field
- a field descriptor object for the Y field. A String field name or a Number representing a field position can also be used directly, instead of a field descriptor object.
commaAsDecimalSeparator
- [Optional] true to specify that field values are decimal numbers in which the decimal separator is a comma; false to specify it is a dot. The parameter is optional, with false as its default value.
void setYLabels(<Number> labelsNum, <String> labelsClass, <LabelFormatter> labelsFormatter)
labelsNum
- the number of labels to be spread on the Y axis; it should be 1 or greater.
labelsClass
- [Optional] the name of an existing stylesheet, to be applied to the Y axis label HTML elements. The parameter is optional; if missing or null, then no specific stylesheet is applied.
labelsFormatter
- [Optional] a LabelFormatter instance, that provides a method to format the Y axis values designated for the labels. The parameter is optional; if missing or null, then a default LabelFormatter object is used.
|
HTML Client 5.0.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |