quadbase.util
Interface IDataPointSet

public interface IDataPointSet

Properties for chart data points can be directly changed by calling methods on this interface. A handle to an object that implements this interface can be obtained by calling the gethDataPoints method defined in QbChart.

Field Summary

static int	DAY
static int	HOUR
static int	MINUTE
static int	MONTH
static int	SECOND
static int	TICKER
static int	WEEK
static int	YEAR Constants for the Ticker/Date/Time units

Method Summary

boolean	areConnectLinesVisible() Returns whether or not the chart currently displays connecting lines for the data points.
boolean[]	areHidden(int colIndex) This function is used to get the hidden status of column values in the legend.
boolean	arePointsUniformForLine() This method returns whether the points are drawn uniformly.
boolean	arePointsVisible() Returns the display status of the data points.
float	getBarGapToWidthRatio() Gets the ratio of the bar width and the distance between bars.
java.awt.Color	getCandleStickDownColor() This method gets the downTick candlestick color.
java.awt.Color	getCandleStickUpColor() This method gets the upTick candlestick color.
float	getCandleStickWidth() This method gets the "wicker"--the hi & low extensions of candlesticks.
java.awt.Color[]	getColors() Returns the color scheme for the data points plotted in the chart.
java.awt.Color	getDataBorderColor() Returns border color of the data points for some chart types.
int	getDataBorderThickness() Returns border thickness of the data points for some chart types.
int[]	getDataLineThickness() This function returns the line thickness for 2D charts
int	getGridStep(int colIndex) Deprecated. Please use getTickerStep(int colIndex) The step size of ticker should equal step size of grid, except after label filtering for date-time chart
IHint	gethHint() Used to get a handle to the IHint interface.
ILabel	gethLabel() Returns a handle to the properties of the labels at the top of data points.
ILabel	gethSecondaryLabel() Returns a handle to the properties of the labels at the top of data points of secondary axis.
IFormat	getLabelFormat(int colIndex) This function is used to get the label format for the given column index.
int	getLabelStep(int colIndex) This function returns the step size for the label display.
int	getLabelUnit(int colIndex) This function is used to obtain the unit information of the label Label unit is associated with the individual column not the axis.
int[]	getLineStyles() Returns the line styles used to draw the different connect lines.
int	getLineThickness() Deprecated. Please use getDataLineThickness() and use @link ISecondaryChart#getDataLineThickness for secondary chart
int	getLineXOffset() Gets the X axis shift value in pixels.
float	getMaxBarWidthRatioToPlotArea() Gets the ratio of the max bar width to the plot area.
int	getMaxDisplayCharactersForText() Returns the number of display characters for text.
java.lang.Double	getMaxYCutOffPointForScatter() This method return the value of the max Y cut-off point for scatter chart
java.lang.String[]	getOrder(int seriesType) This function returns the data points in the series, category, or sum-by column.
java.util.Enumeration	getOriginalTextList() Returns all original text list for text replacement
int[]	getPointShapes() Returns the array of data point shapes displayed in the chart.
int[]	getPointSizes() Sets the point sizes for all the data points displayed in the chart.
java.lang.String	getReplacedText(java.lang.String originalText) Returns a replaced text for a given original text
java.util.Enumeration	getReplacedTextList() Returns all replaced text list for text replacement
int	getStackLabelAlignment() Returns alignment position for the stack section labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE
int	getTickerStep(int colIndex) This function is used to retrieve the ticker step size for the given column index.
int	getTopLabelAlignment() Returns alignment position for the top labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE
java.awt.Color	getTopLabelColorOnNegativeSide() Returns top label color for negative side
boolean	isAreaVisible() Returns the display status of the data area for radar chart.
boolean	isBlackBorderVisibleForWhiteArea() Returns whether or not a black border is drawn around the white data area for some chart types.
boolean	isBorderVisible() Returns whether or not a border is drawn around the data points for some chart types.
boolean	isConnectLinesInOriginalOrder() Returns a boolean value that specifies if connecting lines are drawn in the original dataset order.
boolean	isDisableJava2DForStraightText() Returns whether the Java2D Rotated Text method is using for 0, 90, 180...
boolean	isDottedLineForNull() Returns whether or not the display of dotted lines for missing or null data points is enabled.
boolean	isEndToEnd() Returns whether a chart is drawn from end to end (no gap).
boolean	isJava2DRotateTextEnabled() Returns whether the Java2D Rotate Text method is used
boolean	isLabelOnNegativeSide() Returns whether every label is forced to display on the negative side of the axis.
boolean	isLabelOnPositiveSide() Returns whether every label is forced to display on the positive side of the axis.
boolean	isLimitAtAxisScale() This function return the state of data limit If FALSE, no data limit If TRUE, no data can go over axis max scale or go below axis min scale
boolean	isNullDataAsZero() Returns whether or not to treat null data as zero values.
boolean	isPointBorderVisible() Returns the display status of the data point border.
boolean	isShowNullInScatter() Returns whether or not to show null data in scatter.
boolean	isShowSeriesInTopLabel() Returns whether a 2D scatter is showing series in top label.
boolean	isShowShadowOnLine() Returns whether or not the chart currently displays shadow on lines.
boolean	isShowShadowOnPoint() Returns whether or not the chart currently displays shadow on datapoints.
boolean	isStackSectionLabelVisible() Returns whether the individual section labels in a StackBar, StackColumn, or StackArea Chart is visible.
boolean	isStackSectionTotalLabelVisible() Returns the whether the total label in a StackBar, StackColumn, or StackArea Chart is visible.
boolean	isTranslucent() This method returns whether the chart is translucent For QbChart.OVERLAY, QbChart.RADAR ,2D QbChart.AREA and Stack Area-Col Combo only
boolean	isUniqueColumnColorForColumnChart() Returns whether a different color can be assigned to each column in column chart.
boolean	isXAxisDrawnAtTop() Returns a boolean value that specifies if X-Axis is drawn at the top.
boolean	isZeroAsNullData() Returns whether or not to treat zero values as null data.
void	replace(java.lang.String originalText, java.lang.String replacedText) Replacing all occurrences of originalText in the chart with replacedText
void	reverseOrder(int seriesType) This function reverses the order of the data points in the series, category, or sum-by column.
void	setAreaVisible(boolean b) Enables/Disables the display of data area in the radar chart.
void	setBarGapToWidthRatio(float x) Sets the bar gap to width ratio for bar/column charts.
void	setBlackBorderVisibleForWhiteArea(boolean b) Enables/Disables drawing of a black border around the white data area for some chart types.
void	setBorderVisible(boolean b) Enables/Disables drawing of a border around the data for some chart types.
void	setCandleStickColors(java.awt.Color upTickColor, java.awt.Color downTickColor) This method sets the upTick and downTick candlestick colors.
void	setCandleStickWidth(float wickerWidth) This method sets the "wicker"--the hi & low extensions of candlesticks.
void	setColors(java.awt.Color[] color) Sets a color scheme for the data points plotted.
void	setColors(java.awt.Color[] color, java.awt.Color rootColor) Sets a color scheme for the data points plotted.
void	setColorSeparators(java.awt.Color[] color, java.lang.Object[] value, int order) This method is used for defining the color of the chart based on separator value.
void	setConnectLinesInOriginalOrder(boolean origOrder) Specifies whether the connecting line between datapoints is drawn in the same order in the dataset.
void	setConnectLinesVisible(boolean b) Enables/Disables the drawing of lines connecting adjacent data points in a chart.
void	setDataBorderColor(java.awt.Color c) Sets border color of the data for some chart types.
void	setDataBorderThickness(int i) Sets border thickness of the data for some chart types.
void	setDataLabelInfo(IDataLabelInfo dataLabelInfo) Set the display text for primary data top label
void	setDataLineForNull(boolean b, boolean drawDottedLine) This function enables/disables drawing data lines for missing or null data points.
void	setDataLineThickness(int[] lineThickness) Sets the line thickness for all the data lines displayed in the chart.
void	setDisableJava2DForStraightText(boolean state) If the new state is true, the straight text (0, 90, 180...
void	setDottedLineForNull(boolean b) This function enables/disables drawing dotted lines for missing or null data points.
void	setEndToEnd(boolean state) Enables/Disables drawing of a chart from end to end, skip all the gaps.
void	setGridStep(int colIndex, int size) Deprecated. Please use getTickerStep(int colIndex, int size) The step size of ticker should equal step size of grid, except after label filtering for date-time chart
void	setHidden(int colIndex, boolean[] b) This function sets the hidden status for the column values in the legend.
void	setJava2DRotateTextEnabled(boolean state) If the new state is true, rotated text would be rendered through Java2D.
void	setLabelFormat(int colIndex, IFormat format) This function sets the label format for the given column index.
void	setLabelOnNegativeSide(boolean state) If the new state is true, this method forces every label to display on the negative side of the axis, no matter the data value is positive or not.
void	setLabelOnPositiveSide(boolean state) If the new state is true, this method forces every label to display on the positive side of the axis, no matter the data value is positive or not.
void	setLabelStep(int colIndex, int size) This function sets the label step size for the given column.
void	setLabelStep(int colIndex, int size, int unit, boolean isAscending, java.util.Date startingDate) This function sets the label step size for the given column.
void	setLimitAtAxisScale(boolean state) This function sets the data limit at axis scale If sets, no data can go over axis max scale or go below axis min scale The default value is FALSE
void	setLineStyles(int[] style) Sets the line styles for the connect data lines drawn in the chart.
void	setLineThickness(int thickness) Deprecated. Please use setDataLineThickness(int[] thickness) use @link ISecondaryChart#setDataLineThickness for secondary chart
void	setLineXOffset(int offset) Shift the points drawn along the X axis away from the origin.
void	setMaxBarWidthRatioToPlotArea(float x) Sets the max bar width to plot area ratio for bar/column charts.
void	setMaxDisplayCharactersForText(int maxCh) Sets the number of display characters for text.
void	setMaxYCutOffPointForScatter(java.lang.Double value) This method set the max Y cut-off point for scatter chart
void	setNullDataAsZero(boolean b) This function enables/disables treating null data as zero values.
void	setOrder(int seriesType, java.lang.String[] data) Sets the order of the data points for the series, category, or sumby column.
void	setPointBorderVisible(boolean b) Enables/Disables the display of data point border in the chart.
void	setPointShapes(int[] shapes) Sets the point shapes for drawing the data points in the chart.
void	setPointSizes(int[] size) Sets the point size for all the data points displayed in the chart.
void	setPointsUniformForLine(boolean b) If new state is true, the points are drawn uniformly.
void	setPointsVisible(boolean b) Enables/Disables the display of data points in the chart.
void	setPositionFromOrigin(float chartMidPoint) Sets the chart position to be fixed from the origin of the canvas
void	setSecondaryDataLabelInfo(IDataLabelInfo dataLabelInfo) Set the display text for secondary data top label
void	setShowNullInScatter(boolean b) This function enables/disables showing null data in scatter chart.
void	setShowShadowOnLine(boolean b) Enables/Disables the drawing shadow on lines in a chart.
void	setShowShadowOnPoint(boolean b) Enables/Disables the drawing shadow on datapoints in a chart.
void	setSortOrder(int seriesType, int type) Sets the sort order of the series, category, or sumby column to ascending or descending.
void	setSortSeriesByValue(boolean state) Sorts the series in the order of series sum such that the lowest sum would appear in front.
void	setStackLabelAlignment(int align) Sets alignment position for the stack section labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE
void	setStackSectionLabelVisible(boolean state) Specifies whether the individual section labels in a StackBar, StackColumn or StackArea Chart is visible.
void	setStackSectionTotalLabelVisible(boolean state) Specifies whether the total label in a StackBar, StackColumn or StackArea Chart is visible.
void	setTickerStep(int colIndex, int size) This function is used to set the ticker step size for a particular column.
void	setTopLabelAlignment(int align) Sets alignment position for the top labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE
void	setTopLabelColorOnNegativeSide(java.awt.Color c) Sets top label color for negative side
void	setTranslucent(boolean b) If new state is true, the overlay parts of the chart are drawn in a partially transparent method.
void	setUniqueColumnColorForColumnChart(boolean b) Sets whether a different color can be assigned to each column in column chart.
void	setValueSortOrder(int type) Sorts the value column in Ascending or Descending order.
void	setXAxisDrawnAtTop(boolean shift) Specifies whether the X-Axis is drawn at the top of the chart.
void	setZeroAsNullData(boolean b) This function enables/disables treating zero values as null data.
void	showSeriesInTopLabel(boolean state) If the new state is true, this method would display series in top label.

Field Detail

YEAR

public static final int YEAR

Constants for the Ticker/Date/Time units

MONTH

public static final int MONTH

WEEK

public static final int WEEK

DAY

public static final int DAY

HOUR

public static final int HOUR

MINUTE

public static final int MINUTE

SECOND

public static final int SECOND

TICKER

public static final int TICKER

Method Detail

getOrder

public java.lang.String[] getOrder(int seriesType)

This function returns the data points in the series, category, or sum-by column. The data points are returned in the same order that they appear in the chart.

 Associated QbChart properties: 
   SERIES_ORDER
   CATEGORY_ORDER
   SUMBY_ORDER
 

Parameters:

seriesType - The series type needed. Options are:

   QbChart.CATEGORY
   QbChart.SERIES
   QbChart.SUMBY 

Returns:

An array of strings containing the data points for that column.

setOrder

public void setOrder(int seriesType,
                     java.lang.String[] data)

Sets the order of the data points for the series, category, or sumby column.

Parameters:

seriesType - The series needed.

data - The data points as a string array.

See Also:

getOrder(int)

reverseOrder

public void reverseOrder(int seriesType)

This function reverses the order of the data points in the series, category, or sum-by column.

Parameters:

seriesType - The series type needed. Options are:

   QbChart.CATEGORY
   QbChart.SERIES
   QbChart.SUMBY 

setSortOrder

public void setSortOrder(int seriesType,
                         int type)

Sets the sort order of the series, category, or sumby column to ascending or descending.

Parameters:

seriesType - QbChart.CATEGORY, QbChart.SERIES, or QbChart.SUMBY

type - QbChart.ASCENDING or QbChart.DESCENDING

setValueSortOrder

public void setValueSortOrder(int type)

Sorts the value column in Ascending or Descending order.

Associated QbChart property: VALUE_ORDER

Parameters:

type - QbChart.ASCENDING or QbChart.DESCENDING

setSortSeriesByValue

public void setSortSeriesByValue(boolean state)

Sorts the series in the order of series sum such that the lowest sum would appear in front. For 3-D Column and Area charts only.

isUniqueColumnColorForColumnChart

public boolean isUniqueColumnColorForColumnChart()

Returns whether a different color can be assigned to each column in column chart.

setUniqueColumnColorForColumnChart

public void setUniqueColumnColorForColumnChart(boolean b)

Sets whether a different color can be assigned to each column in column chart.

getColors

public java.awt.Color[] getColors()

Returns the color scheme for the data points plotted in the chart. The Color Objects could also be quadbase.chart.QbPattern type.

See Also:

setColors(java.awt.Color[])

setColors

public void setColors(java.awt.Color[] color)

Sets a color scheme for the data points plotted. The colors in the scheme could be of the type quadbase.chart.QbPattern

Associated QbChart property: DATACOLOR

Parameters:

color - The array containing the color scheme for the points.

 The size of the array depends on the chart type: For a plain
 column chart with no series or category, it is N, where N is the
 number of points in the category column.
 For a stack column chart with no series, it is M, where M is the
 number of points in the sum-by column.
 For a stack column chart with series, it is M x P, where P is the
 number of points in the series column.
 

setColors

public void setColors(java.awt.Color[] color,
                      java.awt.Color rootColor)

Sets a color scheme for the data points plotted.

Associated QbChart property: DATACOLOR

Parameters:

color - The array containing the color scheme for the points.

 The size of the array depends on the chart type: For a plain
 column chart with no series or category, it is N, where N is the
 number of points in the category column.
 For a stack column chart with no series, it is M, where M is the
 number of points in the sum-by column.
 For a stack column chart with series, it is M x P, where P is the
 number of points in the series column.
 

rootColor - The color scheme for the root point

setColorSeparators

public void setColorSeparators(java.awt.Color[] color,
                               java.lang.Object[] value,
                               int order)

This method is used for defining the color of the chart based on separator value. The array size of color should always equals to array size of value + 1.
For example, GREEN < 5 < ORANGE < 20 < RED, all the columns between 5 and 20 should be orange. And the columns < 20 should be red.
In ascending order, the value object array should be {new Integer(5), new Integer(20)}
In descending order, the value object array should be {new Integer(20), new Integer(5)}
Separator value Object can be String, java.lang.Number, Boolean or java.util.Date

Parameters:

color - The array containing the color scheme for separator points

value - The array of separator object which can be java.lang.Number, String Boolean or java.util.Date

order - Set the sort order of the column : QbChart.ASCENDING or QbChart.DESCENDING

gethLabel

public ILabel gethLabel()

Returns a handle to the properties of the labels at the top of data points. Properties of top labels can be directly changed by calling methods on this interface.

Returns:

a handle to the interface quadbase.util.ILabel of top labels.

See Also:

ILabel

getTopLabelAlignment

public int getTopLabelAlignment()

Returns alignment position for the top labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE

setTopLabelAlignment

public void setTopLabelAlignment(int align)

Sets alignment position for the top labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE

Parameters:

align - alignment position

getTopLabelColorOnNegativeSide

public java.awt.Color getTopLabelColorOnNegativeSide()

Returns top label color for negative side

setTopLabelColorOnNegativeSide

public void setTopLabelColorOnNegativeSide(java.awt.Color c)

Sets top label color for negative side

getStackLabelAlignment

public int getStackLabelAlignment()

Returns alignment position for the stack section labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE

setStackLabelAlignment

public void setStackLabelAlignment(int align)

Sets alignment position for the stack section labels alignment position: QbChart.TOP_ALIGNMENT, CENTER_ALIGNMENT, BOTTOM_ALIGNMENT, QbChart.TOP_ALIGNMENT_INSIDE, QbChart.BOTTOM_ALIGNMENT_INSIDE

Parameters:

align - alignment position

gethSecondaryLabel

public ILabel gethSecondaryLabel()

Returns a handle to the properties of the labels at the top of data points of secondary axis. Properties of top labels can be directly changed by calling methods on this interface.

Returns:

a handle to the interface quadbase.util.ILabel of top labels.

See Also:

ILabel

setStackSectionLabelVisible

public void setStackSectionLabelVisible(boolean state)

Specifies whether the individual section labels in a StackBar, StackColumn or StackArea Chart is visible. The top labels would also need to be set.

isStackSectionLabelVisible

public boolean isStackSectionLabelVisible()

Returns whether the individual section labels in a StackBar, StackColumn, or StackArea Chart is visible.

setStackSectionTotalLabelVisible

public void setStackSectionTotalLabelVisible(boolean state)

Specifies whether the total label in a StackBar, StackColumn or StackArea Chart is visible. The top labels would also need to be set.

isStackSectionTotalLabelVisible

public boolean isStackSectionTotalLabelVisible()

Returns the whether the total label in a StackBar, StackColumn, or StackArea Chart is visible.

setDataLabelInfo

public void setDataLabelInfo(IDataLabelInfo dataLabelInfo)

Set the display text for primary data top label

Parameters:

dataLabelInfo - The display label for primary axis data

See Also:

IDataLabelInfo

setSecondaryDataLabelInfo

public void setSecondaryDataLabelInfo(IDataLabelInfo dataLabelInfo)

Set the display text for secondary data top label

Parameters:

dataLabelInfo - The display label for secondary axis data

See Also:

IDataLabelInfo

isLabelOnPositiveSide

public boolean isLabelOnPositiveSide()

Returns whether every label is forced to display on the positive side of the axis. For QbChart.COL and QbChart.BAR charts only. The default value is false for 2D charts and true for 3D charts.

Returns:

the state

setLabelOnPositiveSide

public void setLabelOnPositiveSide(boolean state)

If the new state is true, this method forces every label to display on the positive side of the axis, no matter the data value is positive or not. Vice versa. For QbChart.COL and QbChart.BAR charts only. The default value is false for 2D charts and true for 3D charts.

Parameters:

state - The new state

isLabelOnNegativeSide

public boolean isLabelOnNegativeSide()

Returns whether every label is forced to display on the negative side of the axis. For QbChart.COL and QbChart.BAR charts only. The default value is false.

Returns:

the state

setLabelOnNegativeSide

public void setLabelOnNegativeSide(boolean state)

If the new state is true, this method forces every label to display on the negative side of the axis, no matter the data value is positive or not. Vice versa. For QbChart.COL and QbChart.BAR charts only. The default value is false.

Parameters:

state - The new state

isShowSeriesInTopLabel

public boolean isShowSeriesInTopLabel()

Returns whether a 2D scatter is showing series in top label. For 2D QbChart.SCATTER charts only. The default value is false.

Returns:

the state

showSeriesInTopLabel

public void showSeriesInTopLabel(boolean state)

If the new state is true, this method would display series in top label. For 2D QbChart.SCATTER charts only. The default value is false.

Parameters:

state - The new state

isJava2DRotateTextEnabled

public boolean isJava2DRotateTextEnabled()

Returns whether the Java2D Rotate Text method is used

Returns:

the state

setJava2DRotateTextEnabled

public void setJava2DRotateTextEnabled(boolean state)

If the new state is true, rotated text would be rendered through Java2D.

Parameters:

state - The new state

isDisableJava2DForStraightText

public boolean isDisableJava2DForStraightText()

Returns whether the Java2D Rotated Text method is using for 0, 90, 180... degree text

Returns:

the state

setDisableJava2DForStraightText

public void setDisableJava2DForStraightText(boolean state)

If the new state is true, the straight text (0, 90, 180... degree) would not be rendered through Java2D.

Parameters:

state - The new state

getMaxDisplayCharactersForText

public int getMaxDisplayCharactersForText()

Returns the number of display characters for text. A return value of one -1 will show all characters.

Returns:

the max display characters

setMaxDisplayCharactersForText

public void setMaxDisplayCharactersForText(int maxCh)

Sets the number of display characters for text. Set display character to -1 to show all characters

Parameters:

maxCh - the max display characters

replace

public void replace(java.lang.String originalText,
                    java.lang.String replacedText)

Replacing all occurrences of originalText in the chart with replacedText

Parameters:

originalText - The original text

replacedText - The replaced text

getReplacedText

public java.lang.String getReplacedText(java.lang.String originalText)

Returns a replaced text for a given original text

Parameters:

originalText - The original text

Returns:

the replaced text

getOriginalTextList

public java.util.Enumeration getOriginalTextList()

Returns all original text list for text replacement

Returns:

list of original text

getReplacedTextList

public java.util.Enumeration getReplacedTextList()

Returns all replaced text list for text replacement

Returns:

list of replaced text

gethHint

public IHint gethHint()

Used to get a handle to the IHint interface. This can be used to set various properties associated with the hints displayed for the datapoints in the chart.

 Associated QbChart properties: 
   SHOW_DATAHINT
   DATAHINT_BACKGROUND
   DATAHINT_FONTCOLOR
   DATAHINT_FONT
 

Returns:

A handle to an object that implements quadbase.util.IHint

See Also:

IHint

getBarGapToWidthRatio

public float getBarGapToWidthRatio()

Gets the ratio of the bar width and the distance between bars. Only valid for bar/column/stack bar/stack column charts.

Returns:

The bar width to gap ratio

See Also:

setBarGapToWidthRatio(float)

setBarGapToWidthRatio

public void setBarGapToWidthRatio(float x)

Sets the bar gap to width ratio for bar/column charts. A lower number implies thick bars with very little spacing between adjacent bars.

Associated QbChart property: BARWIDTH_RATIO

Parameters:

x - The bar width to gap ration

getMaxBarWidthRatioToPlotArea

public float getMaxBarWidthRatioToPlotArea()

Gets the ratio of the max bar width to the plot area. Only valid for bar/column/stack bar/stack column/100% column/box charts.

Returns:

The max bar width to plot area ratio

See Also:

setMaxBarWidthRatioToPlotArea(float)

setMaxBarWidthRatioToPlotArea

public void setMaxBarWidthRatioToPlotArea(float x)

Sets the max bar width to plot area ratio for bar/column charts. Only valid for bar/column/stack bar/stack column/100% column/box charts.

Parameters:

x - The max bar width to plot area ratio

isEndToEnd

public boolean isEndToEnd()

Returns whether a chart is drawn from end to end (no gap). Only valid for 2D line/area/stackarea charts. The default value is true.

Returns:

True if a chart is drawn from end to end. False otherwise.

setEndToEnd

public void setEndToEnd(boolean state)

Enables/Disables drawing of a chart from end to end, skip all the gaps. Only valid for 2D line/area/stackarea charts.

Parameters:

state - Set to true/false to enable/disable drawing of a chart from end to end

isBorderVisible

public boolean isBorderVisible()

Returns whether or not a border is drawn around the data points for some chart types.

Returns:

True if border drawing is enabled. False otherwise.

See Also:

setBorderVisible(boolean)

setBorderVisible

public void setBorderVisible(boolean b)

Enables/Disables drawing of a border around the data for some chart types. Valid chart types are: 2D Bar/ Column, 2D Pie, 2D Area, 2D Stack Area 2D Stack Bar/ Column and 100% Column charts.

Associated QbChart property: DRAW_DATABORDER

Parameters:

b - Set to true/false to enable/disable drawing of a border around the data points.

isBlackBorderVisibleForWhiteArea

public boolean isBlackBorderVisibleForWhiteArea()

Returns whether or not a black border is drawn around the white data area for some chart types.

Returns:

True if border drawing is enabled. False otherwise.

See Also:

setBorderVisible(boolean)

setBlackBorderVisibleForWhiteArea

public void setBlackBorderVisibleForWhiteArea(boolean b)

Enables/Disables drawing of a black border around the white data area for some chart types. Valid chart types are: 2D Bar/ Column, 2D Pie, 2D Area, 2D Stack Area 2D Stack Bar/ Column and 100% Column charts.

Associated QbChart property: DRAW_DATABORDER

Parameters:

b - Set to true/false to enable/disable drawing of a border around the data points.

getDataBorderColor

public java.awt.Color getDataBorderColor()

Returns border color of the data points for some chart types.

Returns:

Color of the border.

See Also:

setDataBorderColor(java.awt.Color)

setDataBorderColor

public void setDataBorderColor(java.awt.Color c)

Sets border color of the data for some chart types. Valid chart types are: 2D Bar/ Column, 2D Stack Bar/ Column and 100% Column charts.

Parameters:

c - border color

getDataBorderThickness

public int getDataBorderThickness()

Returns border thickness of the data points for some chart types.

Returns:

border thickness.

See Also:

setDataBorderThickness(int)

setDataBorderThickness

public void setDataBorderThickness(int i)

Sets border thickness of the data for some chart types. Valid chart types are: 2D Bar/ Column, 2D Stack Bar/ Column and 100% Column charts.

Parameters:

c - border thickness

areConnectLinesVisible

public boolean areConnectLinesVisible()

Returns whether or not the chart currently displays connecting lines for the data points.

Returns:

True if connecting lines are displayed. False otherwise.

See Also:

setConnectLinesVisible(boolean)

setConnectLinesVisible

public void setConnectLinesVisible(boolean b)

Enables/Disables the drawing of lines connecting adjacent data points in a chart.

Associated QbChart property: DRAW_LINE

Parameters:

b - Set to true/false to enable/disable drawing of connecting lines.

isShowShadowOnLine

public boolean isShowShadowOnLine()

Returns whether or not the chart currently displays shadow on lines. The default value is true

Returns:

True if shadow of lines are displayed. False otherwise.

See Also:

setShowShadowOnLine(boolean)

setShowShadowOnLine

public void setShowShadowOnLine(boolean b)

Enables/Disables the drawing shadow on lines in a chart. The default value is true

Parameters:

b - Set to true/false to enable/disable drawing shadow on lines.

isShowShadowOnPoint

public boolean isShowShadowOnPoint()

Returns whether or not the chart currently displays shadow on datapoints. The default value is true

Returns:

True if shadow of datapoints are displayed. False otherwise.

setShowShadowOnPoint

public void setShowShadowOnPoint(boolean b)

Enables/Disables the drawing shadow on datapoints in a chart. The default value is true

Parameters:

b - Set to true/false to enable/disable drawing shadow on datapoints.

getLineThickness

public int getLineThickness()

Deprecated. Please use getDataLineThickness() and use @link ISecondaryChart#getDataLineThickness for secondary chart

This function returns the data line thickness for 2D charts.

Returns:

The data line thickness value.

setLineThickness

public void setLineThickness(int thickness)

Deprecated. Please use setDataLineThickness(int[] thickness) use @link ISecondaryChart#setDataLineThickness for secondary chart

Sets the data line thickness for 2D charts.

Parameters:

thickness - The thickness value for drawing data lines.

getLineXOffset

public int getLineXOffset()

Gets the X axis shift value in pixels.

Returns:

The X axis shift value.

setLineXOffset

public void setLineXOffset(int offset)

Shift the points drawn along the X axis away from the origin.

Associated QbChart property: X_SHIFT

Parameters:

offset - The value, in pixels, to shift the points along the X axis.

isDottedLineForNull

public boolean isDottedLineForNull()

Returns whether or not the display of dotted lines for missing or null data points is enabled.

Returns:

True if missing points are connected by dotted lines, false otherwise.

setDottedLineForNull

public void setDottedLineForNull(boolean b)

This function enables/disables drawing dotted lines for missing or null data points.

Associated QbChart property: SHOW_NULLDATALINE

Parameters:

b - Set to true if dotted lines are to be displayed for missing data values, false otherwise.

See Also:

setConnectLinesVisible(boolean)

setDataLineForNull

public void setDataLineForNull(boolean b,
                               boolean drawDottedLine)

This function enables/disables drawing data lines for missing or null data points.

Parameters:

b - Set to true if data lines are to be displayed for missing data values

drawDottedLine - Set to true if want to use dotted line style to display null data

See Also:

setConnectLinesVisible(boolean)

isZeroAsNullData

public boolean isZeroAsNullData()

Returns whether or not to treat zero values as null data.

Returns:

True if treating zero values as null data, false otherwise.

setZeroAsNullData

public void setZeroAsNullData(boolean b)

This function enables/disables treating zero values as null data.

Parameters:

b - Set to true if treated zero values as null data, false otherwise.

isNullDataAsZero

public boolean isNullDataAsZero()

Returns whether or not to treat null data as zero values.

Returns:

True if treating null data as zero values, false otherwise.

setNullDataAsZero

public void setNullDataAsZero(boolean b)

This function enables/disables treating null data as zero values.

Parameters:

b - Set to true if treating null data as zero values, false otherwise.

isShowNullInScatter

public boolean isShowNullInScatter()

Returns whether or not to show null data in scatter.

Returns:

True if showing null data in scatter, false otherwise.

setShowNullInScatter

public void setShowNullInScatter(boolean b)

This function enables/disables showing null data in scatter chart.

Parameters:

b - Set to true if showing null data in scatter, false otherwise.

arePointsVisible

public boolean arePointsVisible()

Returns the display status of the data points.

Returns:

True if data point display is enabled, false otherwise.

setPointsVisible

public void setPointsVisible(boolean b)

Enables/Disables the display of data points in the chart.

Associated QbChart property: DRAW_POINT

Parameters:

b - Set the display status for the data points in the chart.

arePointsUniformForLine

public boolean arePointsUniformForLine()

This method returns whether the points are drawn uniformly. This feature only works for 2D Line Chart with no series.

Returns:

True if data point are drawn uniformly, false otherwise.

setPointsUniformForLine

public void setPointsUniformForLine(boolean b)

If new state is true, the points are drawn uniformly. This feature only works for 2D Line Chart with no series.

Parameters:

b - Set the data points to draw uniformly.

isPointBorderVisible

public boolean isPointBorderVisible()

Returns the display status of the data point border.

Returns:

True if data point border display is enabled, false otherwise.

setPointBorderVisible

public void setPointBorderVisible(boolean b)

Enables/Disables the display of data point border in the chart.

Parameters:

b - Set the display status for the data point border in the chart.

isAreaVisible

public boolean isAreaVisible()

Returns the display status of the data area for radar chart.

Returns:

True if data area display is enabled, false otherwise.

setAreaVisible

public void setAreaVisible(boolean b)

Enables/Disables the display of data area in the radar chart.

Parameters:

b - Set the display status for the data area in the chart.

getPointShapes

public int[] getPointShapes()

Returns the array of data point shapes displayed in the chart.

Returns:

The array of data point shapes.

See Also:

setPointShapes(int[]), setColors(java.awt.Color[])

setPointShapes

public void setPointShapes(int[] shapes)

Sets the point shapes for drawing the data points in the chart. Only valid if display of points is enabled.

Associated QbChart property: DATASHAPE

Parameters:

shapes - The array containing the shapes for all the points. The number of points in this array should match the number used in the setColors() function.

 Available shape values are:
   QbChart.NOSYMBOL
   QbChart.CROSS
   QbChart.CIRCLE
   QbChart.SQUARE
   QbChart.TRIANGLE
   QbChart.PLUS
   QbChart.DASH
   QbChart.STAR 

See Also:

setColors(java.awt.Color[])

getPointSizes

public int[] getPointSizes()

Sets the point sizes for all the data points displayed in the chart.

Returns:

The array of data point sizes.

See Also:

getColors(), getPointShapes()

setPointSizes

public void setPointSizes(int[] size)

Sets the point size for all the data points displayed in the chart.

Associated QbChart property: DATASIZE

Parameters:

size - The array of ints containing all the data point sizes.

See Also:

setColors(java.awt.Color[]), setPointShapes(int[])

getLineStyles

public int[] getLineStyles()

Returns the line styles used to draw the different connect lines. The number of connect lines drawn depends on the chart type. See getColors() to get the length of the return array.

Returns:

The array of line styles.

See Also:

getColors(), getPointShapes(), getPointSizes()

setLineStyles

public void setLineStyles(int[] style)

Sets the line styles for the connect data lines drawn in the chart. A line style basically defines a solid line or various types of dotted/dashed lines.

Associated QbChart property: LINESTYLE

Parameters:

style - The array containing all the line styles.

   A line style number, z, satisfies the equation:
           z = 256*fill + empty
   where fill is the number of fill pixels (solid part of dashed line)
   and empty is the number of blank pixels (empty part of dashed line)
   with fill < 256 and empty < 256.
   By setting well-defined numbers for z, users can create different
   types of connect lines.
 

See Also:

setColors(java.awt.Color[]), setPointShapes(int[]), setPointSizes(int[])

getDataLineThickness

public int[] getDataLineThickness()

This function returns the line thickness for 2D charts

Returns:

The array of data line thickness.

setDataLineThickness

public 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.

getGridStep

public int getGridStep(int colIndex)

Deprecated. Please use getTickerStep(int colIndex) The step size of ticker should equal step size of grid, except after label filtering for date-time chart

This function is used to retrieve the grid step size for the given column index. Grid step sizes are associated with individual columns and not with a particular axis. Associated QbChart property:

           GRID_STEPSIZE
 

Parameters:

colIndex - The column index for which the grid step size is desired.

Returns:

The grid step size.

See Also:

setGridStep(int, int)

setGridStep

public void setGridStep(int colIndex,
                        int size)

Deprecated. Please use getTickerStep(int colIndex, int size) The step size of ticker should equal step size of grid, except after label filtering for date-time chart

This function is used to set the grid step size for a particular column. A step size is the frequency of grid lines displayed for an axis. e.g. A step size of 2 means draw a grid line for every 2nd point on the axis. Grid step sizes are associated with individual columns and not with a particular axis.

Parameters:

colIndex - The column index for which the grid step size is set.

size - The step size.

See Also:

getGridStep(int)

getTickerStep

public int getTickerStep(int colIndex)

This function is used to retrieve the ticker step size for the given column index. Ticker step sizes are associated with individual columns and not with a particular axis. Associated QbChart property:

           TICKER_STEPSIZE
 

Parameters:

colIndex - The column index for which the ticker step size is desired.

Returns:

The ticker step size.

See Also:

setTickerStep(int, int)

setTickerStep

public void setTickerStep(int colIndex,
                          int size)

This function is used to set the ticker step size for a particular column. A step size is the frequency of ticker displayed for an axis. e.g. A step size of 2 means draw a ticker for every 2nd point on the axis. For label filtered date-time chart, a step size of 2 means draw one ticker between labels. (2 equally gap between labels) Ticker step sizes are associated with individual columns and not with a particular axis.

Parameters:

colIndex - The column index for which the ticker step size is set.

size - The step size.

See Also:

getTickerStep(int)

getLabelFormat

public IFormat getLabelFormat(int colIndex)

This function is used to get the label format for the given column index. Associated QbChart property:

           DATA_LABEL_FORMAT
 

Parameters:

colIndex - The column index for which the label format is desired.

Returns:

An object of type IFormat, which contains the label format.

See Also:

IFormat

setLabelFormat

public void setLabelFormat(int colIndex,
                           IFormat format)

This function sets the label format for the given column index.

Parameters:

colIndex - The column index.

format - The object of type IFormat containing the label format.

See Also:

IFormat

getLabelStep

public int getLabelStep(int colIndex)

This function returns the step size for the label display. Label step sizes are associated with individual columns and not with a particular axis. Associated QbChart property:

           DATA_LABEL_STEPSIZE
 

Parameters:

colIndex - The column index for which the label step size is desired.

Returns:

The label step size for that column.

setLabelStep

public void setLabelStep(int colIndex,
                         int size)

This function sets the label step size for the given column. This number indicates how frequently the labels are drawn along the axis. Label step sizes are associated with individual columns and not with a particular axis.

Parameters:

colIndex - The column index.

size - The label step size desired.

See Also:

IAxis.getLabelStep()

setLabelStep

public void setLabelStep(int colIndex,
                         int size,
                         int unit,
                         boolean isAscending,
                         java.util.Date startingDate)

This function sets the label step size for the given column. This number indicates how frequently the labels are drawn along the axis. Label step sizes are associated with individual columns and not with a particular axis. If the column type is TIME/DATE/TIMESTAMP, it can do time-filtering (filter the label by SECOND/MINUTE/HOUR/DAY/MONTH/YEAR)

Parameters:

colIndex - The column index.

size - The label step size desired.

unit - The label interval unit: IDataPointSet.TICKER IDataPointSet.SECOND IDataPointSet.MINUTE IDataPointSet.HOUR IDataPointSet.DAY IDataPointSet.MONTH IDataPointSet.YEAR

isAscending - Set data ordering ( order sorting is required for time-filtering)

startingDate - Set the date to start filtering If startingDate == null, it will find the best fit date to do filtering

See Also:

IAxis.getLabelStep()

getLabelUnit

public int getLabelUnit(int colIndex)

This function is used to obtain the unit information of the label Label unit is associated with the individual column not the axis. Use setLabelStep(.....) to set the label unit. No API for setlabelUnit is implemented such that the unit can be consistent with the input data type of the column

Parameters:

colIndex - the columnIndex of the column

Returns:

an integer that represents the unit. -1 (IDataPointSet.TICKER) means it has no unit or the column is not of Date type.

areHidden

public boolean[] areHidden(int colIndex)

This function is used to get the hidden status of column values in the legend. This status is associated with individual columns and not with a particular axis. Associated QbChart property:

           HIDE_LEGENDITEMS
 

Parameters:

colIndex - The column index for which the status is desired.

Returns:

A boolean array containing the hidden status of each value.

See Also:

setHidden(int, boolean[])

setHidden

public void setHidden(int colIndex,
                      boolean[] b)

This function sets the hidden status for the column values in the legend. This status is associated with individual columns and not with a particular axis.

Parameters:

colIndex - The column index.

b - A boolean array containing the hide status.

See Also:

areHidden(int)

setLimitAtAxisScale

public void setLimitAtAxisScale(boolean state)

This function sets the data limit at axis scale If sets, no data can go over axis max scale or go below axis min scale The default value is FALSE

Parameters:

state - A boolean of set limit at axis scale

isLimitAtAxisScale

public boolean isLimitAtAxisScale()

This function return the state of data limit If FALSE, no data limit If TRUE, no data can go over axis max scale or go below axis min scale

Returns:

the state of data limit

isTranslucent

public boolean isTranslucent()

This method returns whether the chart is translucent For QbChart.OVERLAY, QbChart.RADAR ,2D QbChart.AREA and Stack Area-Col Combo only

Returns:

the state

setTranslucent

public void setTranslucent(boolean b)

If new state is true, the overlay parts of the chart are drawn in a partially transparent method. The default value is false. This method requires JDK 1.2 or above For QbChart.OVERLAY, QbChart.RADAR, 2D QbChart.AREA and Stack Area-Col Combo only

Parameters:

state - The new state

setPositionFromOrigin

public void setPositionFromOrigin(float chartMidPoint)

Sets the chart position to be fixed from the origin of the canvas

Parameters:

chartMidPoint - The distance of the chart from the origin of the canvas represented as a percentage of the width

setCandleStickWidth

public void setCandleStickWidth(float wickerWidth)

This method sets the "wicker"--the hi & low extensions of candlesticks. The value represents the ratio of the wicker width & candlestick width and is to be between 0.1f to 1.0f, inclusive. The default value is 0.3

getCandleStickWidth

public float getCandleStickWidth()

This method gets the "wicker"--the hi & low extensions of candlesticks. The value represents the ratio of the wicker width & candlestick width and is to be between 0.1f to 1.0f, inclusive. The default value is 0.3

setCandleStickColors

public void setCandleStickColors(java.awt.Color upTickColor,
                                 java.awt.Color downTickColor)

This method sets the upTick and downTick candlestick colors. The default upTickColor is Color.green. The default downTickColor is Color.red.

getCandleStickUpColor

public java.awt.Color getCandleStickUpColor()

This method gets the upTick candlestick color. default upTickColor is Color.green

getCandleStickDownColor

public java.awt.Color getCandleStickDownColor()

This method gets the downTick candlestick color. The default downTickColor is Color.red.

setXAxisDrawnAtTop

public void setXAxisDrawnAtTop(boolean shift)

Specifies whether the X-Axis is drawn at the top of the chart. Default x-axis position is at the bottom.

isXAxisDrawnAtTop

public boolean isXAxisDrawnAtTop()

Returns a boolean value that specifies if X-Axis is drawn at the top.

setConnectLinesInOriginalOrder

public void setConnectLinesInOriginalOrder(boolean origOrder)

Specifies whether the connecting line between datapoints is drawn in the same order in the dataset. Default value of false would result in connecting datapoints in ascending x-axis values.

isConnectLinesInOriginalOrder

public boolean isConnectLinesInOriginalOrder()

Returns a boolean value that specifies if connecting lines are drawn in the original dataset order.

setMaxYCutOffPointForScatter

public void setMaxYCutOffPointForScatter(java.lang.Double value)

This method set the max Y cut-off point for scatter chart

Parameters:

value - of the max Y cut-off point for scatter chart

getMaxYCutOffPointForScatter

public java.lang.Double getMaxYCutOffPointForScatter()

This method return the value of the max Y cut-off point for scatter chart

Returns:

value of the max Y cut-off point for scatter chart