com.centrasite.control.ui.util
Class LINECHARTInfo

java.lang.Object
  extended by com.centrasite.control.ui.util.LINECHARTInfo

public class LINECHARTInfo
extends java.lang.Object

Server-side representative for LINECHART control. Use methods createSeries and addPoint to display one line with in the chart control.


Constructor Summary
LINECHARTInfo()
           
 
Method Summary
 void addPoint(java.lang.String id, long time, double value)
           
 void clear()
          Clears the series added to the widget.
 boolean containsSeries(java.lang.String id)
          Method returns true if the given series is already created.
 void createSeries(java.lang.String id, java.lang.String label, java.lang.String unitOfMeasure, java.lang.String color)
          Method creates a new series.
 long getChangeIndex()
           
 java.lang.String getEndDate()
          Get the end range date.
 com.softwareag.cis.server.util.LINECHARTInfoSeries[] getLineChartSeries()
           
 java.lang.String getStartDate()
          Get the start range date.
 void removeSeries(java.lang.String id)
          Method removes the given series id.
 void setEndDate(java.lang.String date)
          Set the end range date.
 void setStartDate(java.lang.String date)
          Set the start range date.
 void updateSeries(java.lang.String id, java.lang.String label, java.lang.String unitOfMeasure, java.lang.String color)
          Method updates the given series id.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LINECHARTInfo

public LINECHARTInfo()
Method Detail

getEndDate

public java.lang.String getEndDate()
Get the end range date.

Returns:
endDate

setEndDate

public void setEndDate(java.lang.String date)
Set the end range date.


getStartDate

public java.lang.String getStartDate()
Get the start range date.

Returns:
startDate

setStartDate

public void setStartDate(java.lang.String date)
Set the start range date.


getChangeIndex

public long getChangeIndex()

removeSeries

public void removeSeries(java.lang.String id)
Method removes the given series id.

Parameters:
id - series identifier - not display at UI

updateSeries

public void updateSeries(java.lang.String id,
                         java.lang.String label,
                         java.lang.String unitOfMeasure,
                         java.lang.String color)
Method updates the given series id.

Parameters:
id - series identifier - not display at UI
label - text that is displayed in legend of widget
unitOfMeasure - text that is displayed in legend of widget
color - RRGGBB string (e.g. 0000FF for blue color)

containsSeries

public boolean containsSeries(java.lang.String id)
Method returns true if the given series is already created.

Parameters:
id - series identifier - not display at UI
Returns:
boolean

createSeries

public void createSeries(java.lang.String id,
                         java.lang.String label,
                         java.lang.String unitOfMeasure,
                         java.lang.String color)
Method creates a new series. Add points afterwards.

Parameters:
id - series identifier - not display at UI
label - text that is displayed in legend of widget
unitOfMeasure - text that is displayed in legend of widget
color - RRGGBB string (e.g. 0000FF for blue color)

addPoint

public void addPoint(java.lang.String id,
                     long time,
                     double value)
Parameters:
id - series identifier as defined in method call createSeries
time - time in milliseconds the value is added for
value - defines a point in time

getLineChartSeries

public com.softwareag.cis.server.util.LINECHARTInfoSeries[] getLineChartSeries()

clear

public void clear()
Clears the series added to the widget.