quadbase.util
Interface IOverlayPropertySet

public interface IOverlayPropertySet

This interface is used to modify the properties associated with a 2D overlay chart.

A handle to an object that implements this interface can be obtained by calling the gethOverlayProperties method defined in QbChart.

eg. QbChart chart = new QbChart(...);
IOverlayPropertySet = chart.gethOverlayProperties();

Field Summary

static int	NEWAXIS
static int	PRIMARYAXIS
static int	SECONDARYAXIS

Method Summary

int	getAxis(int index) This method returns corresponding axis of the specific layer
int	getAxisGapOffset() This method returns the offset of axis gap
boolean	getAxisPosition(int index) This method returns corresponding axis of the specific layer
int	getLayerCount() This method counts the number of layers.
int	getLayerType(int index) This method returns the chart type of the specific layer
boolean	isAutoAxisPosition() This method returns whether the x position of axis is calculated automatically
boolean	isOverlayTransparent() Deprecated. Please use @link IDataPointSet#isTranslucent()
void	setAutoAxisPosition(boolean state) This method sets the x position of axis is calculated automatically
void	setAxis(int index, int assignedAxis) This method set the corresponding axis of the specific layer
void	setAxisGapOffset(int offset) This method set the offset of axis gap
void	setAxisPosition(int index, boolean useSecondaryAxis) This method set the corresponding axis of the specific layer
void	setLayerType(int index, int chartType) This method set the chart type of the specific layer
void	setOverlayTransparent(boolean b) Deprecated. Please use @link IDataPointSet#setTranslucent(boolean b)

Field Detail

NEWAXIS

public static final int NEWAXIS

PRIMARYAXIS

public static final int PRIMARYAXIS

SECONDARYAXIS

public static final int SECONDARYAXIS

Method Detail

getLayerCount

public int getLayerCount()

This method counts the number of layers.

Returns:

number of layer

getLayerType

public int getLayerType(int index)

This method returns the chart type of the specific layer

Parameters:

index - index of the layer

Returns:

corresponding chart type of that layer return -1 if layer is invisible

See Also:

setLayerType(int, int)

setLayerType

public void setLayerType(int index,
                         int chartType)

This method set the chart type of the specific layer

Parameters:

index - index of the layer

chartType - corresponding chart type. Options are:

                  invisible, set chartType = -1
                  QbChart.COL
                  QbChart.AREA
                  QbChart.LINE
See Also: 
getLayerType(int)

getAxisPosition

public boolean getAxisPosition(int index)

This method returns corresponding axis of the specific layer

Parameters:

index - index of the layer

Returns:

draw data base on secondary axis scale

See Also:

setAxisPosition(int, boolean)

setAxisPosition

public void setAxisPosition(int index,
                            boolean useSecondaryAxis)

This method set the corresponding axis of the specific layer

Parameters:

index - index of the layer

useSecondaryAxis - draw data base on secondary axis scale

See Also:

getAxisPosition(int)

getAxis

public int getAxis(int index)

This method returns corresponding axis of the specific layer

Parameters:

index - index of the layer

Returns:

index of axis

See Also:

setAxis(int, int)

setAxis

public void setAxis(int index,
                    int assignedAxis)

This method set the corresponding axis of the specific layer

Parameters:

index - index of the layer

assignedAxis - index of axis

See Also:

getAxis(int)

isAutoAxisPosition

public boolean isAutoAxisPosition()

This method returns whether the x position of axis is calculated automatically

Returns:

the state of auto axis

See Also:

setAutoAxisPosition(boolean)

setAutoAxisPosition

public void setAutoAxisPosition(boolean state)

This method sets the x position of axis is calculated automatically

Parameters:

state - the state of auto axis

See Also:

isAutoAxisPosition()

getAxisGapOffset

public int getAxisGapOffset()

This method returns the offset of axis gap

Returns:

the offset of axis gap

See Also:

setAxisGapOffset(int)

setAxisGapOffset

public void setAxisGapOffset(int offset)

This method set the offset of axis gap

Parameters:

offset - the offset of axis gap

See Also:

getAxisGapOffset()

isOverlayTransparent

public boolean isOverlayTransparent()

Deprecated. Please use @link IDataPointSet#isTranslucent()

This method returns whether the chart is partially transparent

Returns:

the state

setOverlayTransparent

public void setOverlayTransparent(boolean b)

Deprecated. Please use @link IDataPointSet#setTranslucent(boolean b)

If new state is true, the overlay parts of the chart are drawn in partially transparent method. The default value is false. This method requires JDK 1.2 or above

Parameters:

state - The new state