EspressReport 6.6

quadbase.util
Interface IHorzVertLine

All Superinterfaces:
java.lang.Cloneable, IDataLine, IReferenceObj
All Known Subinterfaces:
IControlLine

public interface IHorzVertLine
extends IDataLine

This class is used to draw horizontal/vertical lines in a chart. You may call newHorzVertLine(...) of IDataLineSet interface to get a new object. For instance,
QbChart chart = new QbChart(...);
IHorzVertLine line = chart.gethDataLineSet().newHorzVertLine(...);

See Also:
IDataLineSet

Field Summary
static int CIRCULAR_STYLE
           
static int HORIZONTAL_LINE
           
static int SEGMENTED_STYLE
           
static int VERTICAL_LINE
           
 
Fields inherited from interface quadbase.util.IDataLine
CLOSE, DASH_STYLE, DOTTED_STYLE, HIGH, LOW, OPEN, SOLID_STYLE
 
Method Summary
 java.awt.Color getColorAboveLine()
          Return the value of setColorAboveLine(Color).
 java.awt.Color getColorBelowLine()
          Return the value of setColorBelowLine(Color).
 int getLineType()
          Get the line type
 double getLineValue()
          Get the line value used by horizontal/vertical line type
 void setColorAboveLine(java.awt.Color color)
          Set the color of all chart data line segments that are above this line value (threshold value) to the desired color.
 void setColorBelowLine(java.awt.Color color)
          Set the color of all chart data line segments which are below this line value (threshold value) to the desired color.
 void setLineType(int lineType)
          Sets the line type.
 void setLineValue(double line_value)
          Set the value for the horizontal line or vertical line.
 
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

HORIZONTAL_LINE

static final int HORIZONTAL_LINE
See Also:
Constant Field Values

VERTICAL_LINE

static final int VERTICAL_LINE
See Also:
Constant Field Values

CIRCULAR_STYLE

static final int CIRCULAR_STYLE
See Also:
Constant Field Values

SEGMENTED_STYLE

static final int SEGMENTED_STYLE
See Also:
Constant Field Values
Method Detail

setLineType

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

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

getLineType

int getLineType()
Get the line type

Specified by:
getLineType in interface IDataLine
Returns:
line type

setLineValue

void setLineValue(double line_value)
Set the value for the horizontal line or vertical line. For horizontal line if the Y-axis is of numeric value then the line is drawn using line_value, otherwise (i.e. Y-axis contains category name as in bar chart) the value is interpreted as :
1 - draw a line between 1st and 2nd category,
2 - draw a line between 2nd and 3rd category,
etc...
Similarly, line_value = 1.5 will draw a line on the 2nd category.

For vertical line if the X-axis is of numeric value then the line is drawn using line_value, otherwise the value is interpreted as above.

Specified by:
setLineValue in interface IDataLine

getLineValue

double getLineValue()
Get the line value used by horizontal/vertical line type

Specified by:
getLineValue in interface IDataLine
Returns:
line value

setColorAboveLine

void setColorAboveLine(java.awt.Color color)
Set the color of all chart data line segments that are above this line value (threshold value) to the desired color. Note that setColorAboveLine has a higher precedence than setColorBelowLine. The method has no effect if data connection lines are not shown. If the chart is not a line chart, the program should call gethDataPoints().setConnectLinesVisible(true) before setting the color. The default value is null. For 2D charts only.

Parameters:
color - the desired color

getColorAboveLine

java.awt.Color getColorAboveLine()
Return the value of setColorAboveLine(Color). The default value is null. For 2D charts only.

Returns:
The color

setColorBelowLine

void setColorBelowLine(java.awt.Color color)
Set the color of all chart data line segments which are below this line value (threshold value) to the desired color. Note that setColorAboveLine has a higher precedence than setColorBelowLine. The method has no effect if data connection lines are not shown. If the chart is not a line chart, the program should call gethDataPoints().setConnectLinesVisible(true) before setting the color. The default value is null. For 2D charts only.

Parameters:
color - the desired color

getColorBelowLine

java.awt.Color getColorBelowLine()
Return the value of setColorBelowLine(Color). The default value is null. For 2D charts only.

Returns:
The color

EspressReport 6.6