EspressReport 6.6

quadbase.util
Interface ISecondaryChart

All Superinterfaces:
IGradientPropertySet, IGradientSupport

public interface ISecondaryChart
extends IGradientPropertySet

Properties for the secondary data points can be changed using the methods in this interface. A handle to an object that implements this interface can be obtained by calling the gethSecondaryChart method defined in QbChart.


Method Summary
 boolean areConnectLinesVisible()
          Returns the display status of connect lines for the secondary axis.
 boolean arePointsVisible()
          Gets the display status of the data points for the secondary axis.
 java.awt.Color[] getColors()
          Returns the color scheme for the secondary axis data points plotted in the chart.
 int getCombinationType()
          This function returns the combination chart type.
 int[] getDataLineThickness()
          This function returns the line thickness for 2D charts
 IAxis gethAxis()
          Returns a handle to the secondary axis properties.
 IAxisRuler gethAxisRuler()
          Returns a handle to the axis ruler object for the secondary axis.
 ILegend gethLegend()
          This function returns a handle to the legend properties for the secondary axis.
 int[] getLineStyles()
          Returns the array of line styles used to draw the different connect lines along the secondary axis.
 int[] getPointShapes()
          Returns the array of secondary axis data points shapes displayed in the chart.
 int[] getPointSizes()
          Gets the point sizes for all the secondary axis points displayed in the chart.
 boolean[] getSelectiveStepLineDrawn()
          Returns the boolean array used to determine which lines are step line in the selective step line
 double getStepLineRatio()
          Returns the proportion of the horizontal to the overall step line segment
 boolean isAlignAxisScale()
          Returns whether a chart use same scale system for primary and secondary axis if so, return true, else return false Not available for 100% percent column chart
 boolean isPointBorderColorBlack()
          Returns true if the color of the data point border is black.
 boolean isPointBorderVisible()
          Gets the display status of the data point border for the secondary axis.
 boolean isSelectiveStepLineUsed()
          Returns whether selective step line is used
 boolean isStepLineDrawn()
          Returns if all of the datalines are drawn in the step line fashion
 boolean isSwapAxis()
          Returns the state of the position of secondary axis.
 boolean isUsingPrimaryAxis()
          Returns whether a chart use primary axis to plot secondary axis data if so, return true, else return false Only available for 2D line chart
 void setAlignAxisScale(boolean state)
          Uses the same scale system for primary and secondary axis if the argument is true.
 void setColors(java.awt.Color[] color)
          Sets a color scheme for the secondary axis data points.
 void setCombinationType(int comboType)
          Sets the chart type for the secondary axis.
 void setConnectLinesVisible(boolean b)
          Enables/Disables the drawing of connect lines for the secondary axis.
 void setDataLineThickness(int[] lineThickness)
          Sets the line thickness for all the data lines displayed in the chart.
 void setLineStyles(int[] style)
          This function sets the connect line styles for the secondary axis.
 void setPointBorderColorBlack(boolean b)
          Set the color of data point border to black, otherwises, darker color of the symbol color.
 void setPointBorderVisible(boolean b)
          Enables/Disables the display of data point border for the secondary axis.
 void setPointShapes(int[] shapes)
          Sets the point shapes for drawing the secondary axis data points.
 void setPointSizes(int[] size)
          Sets the point sizes for all the secondary axis data points displayed in the chart.
 void setPointsVisible(boolean b)
          Enables/Disables the display of data points for the secondary axis.
 void setSelectiveStepLineDrawn(boolean[] stepSelect)
          Specifies which lines to draw in the Step Lines fashion.
 void setStepLineDrawn(boolean step)
          Specifies Step Lines to be drawn for all lines.
 void setStepLineDrawn(boolean step, double ratio)
          Specifies Step Lines to be drawn, and the ratio where vertical lines are drawn to the next y value.
 void setStepLineRatio(double ratio)
          Specifies the proportion of the horizontal to the overall step line segment
 void setSwapAxis(boolean state)
          Sets the position of secondary axis.
 void setUsingPrimaryAxis(boolean state)
          Plots secondary axis data base on primary axis if the argument is true.
 void setValueSortOrder(int type)
          Sorts the secondary axis value column in Ascending or descending order.
 
Methods inherited from interface quadbase.util.IGradientPropertySet
set3DShadingEnabled, setGradientCyclic, setGradientDesColor, setGradientEnabled, setGradientEndX, setGradientEndY, setGradientShade, setGradientStartX, setGradientStartY
 
Methods inherited from interface quadbase.util.IGradientSupport
getGradientDesColor, getGradientEndX, getGradientEndY, getGradientShade, getGradientStartX, getGradientStartY, is3DShadingEnabled, isGradientCyclic, isGradientEnabled
 

Method Detail

getCombinationType

int getCombinationType()
This function returns the combination chart type. i.e. The chart type used to draw the secondary axis data points.

Returns:
The Secondary Chart type.
See Also:
setCombinationType(int)

setCombinationType

void setCombinationType(int comboType)
Sets the chart type for the secondary axis.

Associated QbChart property: COMBO_TYPE

Parameters:
comboType - The secondary axis chart type. Available options are:
   QbChart.COMBO_LINE (line chart)
   QbChart.COMBO_STACKAREA (only valid for 2D stack column charts)
   QbChart.COMBO_COL (only valid for Hi-Lo and HLCO chart types)
   QbChart.COMBO_OVERLAY (only valid for 2D column, stack column, stack area,
                                                100% column, Hi-Lo and HLCO chart types)
 

gethLegend

ILegend gethLegend()
This function returns a handle to the legend properties for the secondary axis.

Returns:
a handle to the secondary legend properties.
See Also:
ILegend

gethAxis

IAxis gethAxis()
Returns a handle to the secondary axis properties.

Returns:
a handle to the secondary axis properties.
See Also:
IAxis

getLineStyles

int[] getLineStyles()
Returns the array of line styles used to draw the different connect lines along the secondary axis. The number of connect lines drawn depends on the chart type.

Returns:
The array of line styles for the secondary axis.
See Also:
IDataPointSet.getColors(), IDataPointSet.getLineStyles()

setLineStyles

void setLineStyles(int[] style)
This function sets the connect line styles for the secondary axis.

Associated QbChart property: SLINESTYLE

Parameters:
style - The array of line styles.
See Also:
IDataPointSet.setLineStyles(int[])

arePointsVisible

boolean arePointsVisible()
Gets the display status of the data points for the secondary axis.

Returns:
True if data point display is enabled, false otherwise.
See Also:
IDataPointSet.arePointsVisible()

setPointsVisible

void setPointsVisible(boolean b)
Enables/Disables the display of data points for the secondary axis.

Associated QbChart property: DRAW_SPOINT

Parameters:
b - Set the display status for the secondary axis data points.
See Also:
IDataPointSet.setPointsVisible(boolean)

isPointBorderVisible

boolean isPointBorderVisible()
Gets the display status of the data point border for the secondary axis.

Returns:
True if data point border display is enabled, false otherwise.
See Also:
IDataPointSet.isPointBorderVisible()

setPointBorderVisible

void setPointBorderVisible(boolean b)
Enables/Disables the display of data point border for the secondary axis.

Parameters:
b - Set the display status for the secondary axis data point border.
See Also:
IDataPointSet.setPointBorderVisible(boolean)

isPointBorderColorBlack

boolean isPointBorderColorBlack()
Returns true if the color of the data point border is black. Otherwises, returns flase if the data point border is the darker color of the symbol color

Returns:
the status of black data point border color.

setPointBorderColorBlack

void setPointBorderColorBlack(boolean b)
Set the color of data point border to black, otherwises, darker color of the symbol color.

Parameters:
b - Set the color for the data point border to black.

setConnectLinesVisible

void setConnectLinesVisible(boolean b)
Enables/Disables the drawing of connect lines for the secondary axis.

Associated QbChart property: DRAW_SLINE

Parameters:
b - Set to true/false to enable/disable display of connect lines for the secondary axis data points.
See Also:
IDataPointSet.setConnectLinesVisible(boolean)

areConnectLinesVisible

boolean areConnectLinesVisible()
Returns the display status of connect lines for the secondary axis.

Returns:
True if connect lines for the S axis are visible, false otherwise.
See Also:
IDataPointSet.areConnectLinesVisible()

isStepLineDrawn

boolean isStepLineDrawn()
Returns if all of the datalines are drawn in the step line fashion


isSelectiveStepLineUsed

boolean isSelectiveStepLineUsed()
Returns whether selective step line is used


getStepLineRatio

double getStepLineRatio()
Returns the proportion of the horizontal to the overall step line segment


setStepLineRatio

void setStepLineRatio(double ratio)
Specifies the proportion of the horizontal to the overall step line segment


getSelectiveStepLineDrawn

boolean[] getSelectiveStepLineDrawn()
Returns the boolean array used to determine which lines are step line in the selective step line


setStepLineDrawn

void setStepLineDrawn(boolean step)
Specifies Step Lines to be drawn for all lines. Draws in the horizontal direction first


setSelectiveStepLineDrawn

void setSelectiveStepLineDrawn(boolean[] stepSelect)
Specifies which lines to draw in the Step Lines fashion. Draws in the horizontal direction first


setStepLineDrawn

void setStepLineDrawn(boolean step,
                      double ratio)
Specifies Step Lines to be drawn, and the ratio where vertical lines are drawn to the next y value. Draws step lines in the horizontal direction first.

Parameters:
ratio - use 0.0 to draw vertical line first, 1.0 to draw horizontal lines till the next category, or any number between 0.0 to 1.0 to specify where the "step" occurs.

setValueSortOrder

void setValueSortOrder(int type)
Sorts the secondary axis value column in Ascending or descending order.

Associated QbChart property: SVALUE_ORDER

Parameters:
type - QbChart.ASCENDING or QBChart.DESCENDING
See Also:
IDataPointSet.setValueSortOrder(int)

getPointShapes

int[] getPointShapes()
Returns the array of secondary axis data points shapes displayed in the chart.

Returns:
The array of data point shapes for the secondary axis.
See Also:
IDataPointSet.getPointShapes()

setPointShapes

void setPointShapes(int[] shapes)
Sets the point shapes for drawing the secondary axis data points. Only valid if display of secondary data points is enabled.

Associated QbChart property: SDATASHAPE

Parameters:
shapes - The array of shapes for the secondary axis points.
See Also:
IDataPointSet.setPointShapes(int[])

getPointSizes

int[] getPointSizes()
Gets the point sizes for all the secondary axis points displayed in the chart.

Returns:
The array of secondary axis data point sizes.
See Also:
IDataPointSet.getPointSizes()

setPointSizes

void setPointSizes(int[] size)
Sets the point sizes for all the secondary axis data points displayed in the chart.

Associated QbChart property: SDATASIZE

Parameters:
size - The array of ints containing all the S axis point sizes.
See Also:
IDataPointSet.setPointSizes(int[])

getDataLineThickness

int[] getDataLineThickness()
This function returns the line thickness for 2D charts

Returns:
The array of data line thickness.

setDataLineThickness

void setDataLineThickness(int[] lineThickness)
Sets the line thickness for all the data lines displayed in the chart.

Parameters:
lineThickness - The array of ints containing all the data line thickness.

getColors

java.awt.Color[] getColors()
Returns the color scheme for the secondary axis data points plotted in the chart. The size of the return array depends on the chart type used.

Returns:
The array of Color objects representing the RGB values for all the S axis data points.
See Also:
IDataPointSet.getColors()

setColors

void setColors(java.awt.Color[] color)
Sets a color scheme for the secondary axis data points. The size of the input array depends on the chart type plotted.

Associated QbChart property: SDATACOLOR

Parameters:
color - The array containing the color scheme.
See Also:
IDataPointSet.setColors(java.awt.Color[])

gethAxisRuler

IAxisRuler gethAxisRuler()
Returns a handle to the axis ruler object for the secondary axis.

Returns:
An instance of an object that implements IAxisRuler for the secondary axis.
See Also:
IAxisRuler

setSwapAxis

void setSwapAxis(boolean state)
Sets the position of secondary axis. Swap the position of Y-axis and secondary axis if the argument is true. For 2D charts only

Parameters:
state - The new state of swap axis

isSwapAxis

boolean isSwapAxis()
Returns the state of the position of secondary axis. Returns true if the positions of Y-axis and secondary axis are swapped. For 2D charts only

Returns:
The state

setAlignAxisScale

void setAlignAxisScale(boolean state)
Uses the same scale system for primary and secondary axis if the argument is true. Not available for 100% percent column chart

Parameters:
state - The new state of align axis scale

isAlignAxisScale

boolean isAlignAxisScale()
Returns whether a chart use same scale system for primary and secondary axis if so, return true, else return false Not available for 100% percent column chart

Returns:
The state

setUsingPrimaryAxis

void setUsingPrimaryAxis(boolean state)
Plots secondary axis data base on primary axis if the argument is true. connect primary and secondary axis data point if the category types are the same. Only available for 2D line chart

Parameters:
state - The new state of using primary axis

isUsingPrimaryAxis

boolean isUsingPrimaryAxis()
Returns whether a chart use primary axis to plot secondary axis data if so, return true, else return false Only available for 2D line chart

Returns:
The state

EspressReport 6.6