EspressReport 6.6

quadbase.util
Interface IControlLine

All Superinterfaces:
java.lang.Cloneable, IDataLine, IHorzVertLine, IReferenceObj

public interface IControlLine
extends IHorzVertLine

This class is used to draw control lines in a chart You may call newControlLine(...) of IDataLineSet interface to get a new object For instance, QbChart chart = new QbChart(...); IControlLine line = chart.gethDataLineSet().newControlLine(...); You may use setSeries(String series) method of IDataLine interface to set the corresponding series of the control line

See Also:
IDataLineSet, IDataLine

Field Summary
static int CONTROL_AVERAGE
          A line type constant
static int MAXIMUM
          A line type constant
static int MINIMUM
          A line type constant
static int STANDARD_DEVIATION
          A line type constant
 
Fields inherited from interface quadbase.util.IHorzVertLine
CIRCULAR_STYLE, HORIZONTAL_LINE, SEGMENTED_STYLE, VERTICAL_LINE
 
Fields inherited from interface quadbase.util.IDataLine
CLOSE, DASH_STYLE, DOTTED_STYLE, HIGH, LOW, OPEN, SOLID_STYLE
 
Method Summary
 double getAverage()
          Get the average of the selected data set
 double getCalculatedValue()
          Get the calculated value used for plotting the line
 int getLineType()
          Get the line type
 double getLineValue()
          Get the value of the multiplier
 double getMax()
          Get the maximum value of the selected data set
 double getMin()
          Get the minimum value of the selected data set
 double getStandardDev()
          Get the standard deviation of the selected data set
 void setLineType(int lineType)
          Sets the line type.
 void setLineValue(double line_value)
          This function is only valid for control line STANDARD_DEVIATION.
 
Methods inherited from interface quadbase.util.IHorzVertLine
getColorAboveLine, getColorBelowLine, setColorAboveLine, setColorBelowLine
 
Methods inherited from interface quadbase.util.IDataLine
getCoeff, getColor, getLineStyle, getSeries, getShowHintValue, getThickness, getTitle, getValueColumn, getValueHint, isSecondaryValueUsed, isTitleVisibleInLegend, setCoeff, setColor, setLineStyle, setSeries, setShowHintValue, setThickness, setTitle, setTitleVisibleInLegend, setValueColumn, setValueHint, useSecondaryValue
 
Methods inherited from interface quadbase.util.IReferenceObj
addAnnotation, getAnnotations, getReferencePosition, isVisible, removeAnnotation
 

Field Detail

CONTROL_AVERAGE

static final int CONTROL_AVERAGE
A line type constant

See Also:
Constant Field Values

STANDARD_DEVIATION

static final int STANDARD_DEVIATION
A line type constant

See Also:
Constant Field Values

MINIMUM

static final int MINIMUM
A line type constant

See Also:
Constant Field Values

MAXIMUM

static final int MAXIMUM
A line type constant

See Also:
Constant Field Values
Method Detail

setLineType

void setLineType(int lineType)
Sets the line type. The default type is CONTROL_AVERAGE.

Specified by:
setLineType in interface IDataLine
Specified by:
setLineType in interface IHorzVertLine
Parameters:
lineType - the type of this data line.

getLineType

int getLineType()
Get the line type

Specified by:
getLineType in interface IDataLine
Specified by:
getLineType in interface IHorzVertLine
Returns:
line type

setLineValue

void setLineValue(double line_value)
This function is only valid for control line STANDARD_DEVIATION. It sets the value of the multiplier m for the formula: calculatedValue = average + m * standardDeviation The orientation of the straight depends on the type of the chart For example, a horizontal line is drawn at that calculated position if the chart type is QbChart.COL. A vertical line is drawn if the chart type is QbChart.BAR.

Specified by:
setLineValue in interface IDataLine
Specified by:
setLineValue in interface IHorzVertLine

getLineValue

double getLineValue()
Get the value of the multiplier

Specified by:
getLineValue in interface IDataLine
Specified by:
getLineValue in interface IHorzVertLine
Returns:
line value

getAverage

double getAverage()
Get the average of the selected data set


getStandardDev

double getStandardDev()
Get the standard deviation of the selected data set


getMin

double getMin()
Get the minimum value of the selected data set


getMax

double getMax()
Get the maximum value of the selected data set


getCalculatedValue

double getCalculatedValue()
Get the calculated value used for plotting the line


EspressReport 6.6