quadbase.util
Interface IPlot

All Known Subinterfaces:

IAnnotation, ILegend

public interface IPlot

This interface defines methods to modify properties associated with the plot area for the main chart as well as the legend.

A handle to an object that implements this interface can be obtained in two ways:

1. By calling the gethChartPlot method in QbChart. This returns a handle to the plot area containing the main chart.

2. By obtaining a handle to the ILegend interface, which extends IPlot.

See Also:

ILegend

Method Summary

int	getAppearance() Returns the background appearance for the chart/legend plot area.
java.awt.Color	getBackgroundColor() Returns the color of the chart/legend plot area background.
java.awt.Color	getBorderColor() Returns the color of the chart/legend plot area border.
int	getBorderThickness() Returns the border thickness for the chart plot area.
int	getDepth() Returns the data plotting area depth.
Position	getPosition() Gets the x,y position of the chart/legend plot area relative to the main chart canvas.
float	getRelativeHeight() Returns the height of the plot area relative to the main chart canvas.
float	getRelativeWidth() Returns the width of the plot area relative to the main chart canvas.
boolean	isBackgroundVisible() Returns whether or not the background for the chart/legend plot area is visible.
boolean	isBorderVisible() Returns whether or not a border is drawn around the chart/legend plot area.
void	setAppearance(int x) Sets the background appearance for the chart/legend plot area.
void	setBackgroundColor(java.awt.Color c) Sets the color of the chart/legend plot area background.
void	setBackgroundVisible(boolean b) Enables/Disables drawing of a background for the chart/legend plot area.
void	setBorderColor(java.awt.Color c) Sets the border color for the chart/legend plot area.
void	setBorderThickness(int x) Sets the border thickness for the chart plot area.
void	setBorderVisible(boolean b) Enable/Disable drawing of the border for chart/legend plot area.
void	setDepth(int x) Sets the data plotting area depth.
void	setPosition(Position p) Sets the x,y positon of the chart/legend plot area relative to the main chart window.
void	setRelativeHeight(float height) Sets the height of the plot area relative to the main chart canvas.
void	setRelativeWidth(float width) Sets the width of the plot area relative to the main chart canvas.

Method Detail

getRelativeWidth

public float getRelativeWidth()

Returns the width of the plot area relative to the main chart canvas.

Associated QbChart property: PLOT_WIDTH

Returns:

The relative width of the plot area ( 0 - 1)

setRelativeWidth

public void setRelativeWidth(float width)

Sets the width of the plot area relative to the main chart canvas.

Parameters:

width - The relative width of the chart plot area. Should be between 0 and 1.

getRelativeHeight

public float getRelativeHeight()

Returns the height of the plot area relative to the main chart canvas.

Associated QbChart property: PLOT_HEIGHT

Returns:

The relative height of the plot area (0 - 1)

setRelativeHeight

public void setRelativeHeight(float height)

Sets the height of the plot area relative to the main chart canvas.

Parameters:

height - The relative height of the chart plot area. Should be between 0 and 1.

getPosition

public Position getPosition()

Gets the x,y position of the chart/legend plot area relative to the main chart canvas.

Associated QbChart property:

   PLOT_XPOS
   PLOT_YPOS
   LEGEND_XPOS
   LEGEND_YPOS
 

Returns:

A Position object containing the relative x,y position of the plot area. The x and y values in the Position object are between 0 and 1.

See Also:

Position

setPosition

public void setPosition(Position p)

Sets the x,y positon of the chart/legend plot area relative to the main chart window.

Parameters:

p - The Position object containing the relative positon.

See Also:

Position

isBorderVisible

public boolean isBorderVisible()

Returns whether or not a border is drawn around the chart/legend plot area.

Associated QbChart property:

   DRAW_PLOTBORDER
   LEGEND_DRAWBORDER
 

Returns:

True if the plot area border is visible, false otherwise.

setBorderVisible

public void setBorderVisible(boolean b)

Enable/Disable drawing of the border for chart/legend plot area.

Parameters:

b - The border drawing status.

getBorderColor

public java.awt.Color getBorderColor()

Returns the color of the chart/legend plot area border.

Associated QbChart property:

   PLOT_BORDERCOLOR
   LEGEND_BORDERCOLOR
 

Returns:

The Color object containing the border color.

See Also:

isBorderVisible()

setBorderColor

public void setBorderColor(java.awt.Color c)

Sets the border color for the chart/legend plot area.

Parameters:

c - The Color object containing the border color.

getBorderThickness

public int getBorderThickness()

Returns the border thickness for the chart plot area.

Associated QbChart property: PLOT_BORDER_THICKNESS

Returns:

The border thickness value.

setBorderThickness

public void setBorderThickness(int x)

Sets the border thickness for the chart plot area.

Parameters:

x - The border thickness value.

isBackgroundVisible

public boolean isBackgroundVisible()

Returns whether or not the background for the chart/legend plot area is visible.

Associated QbChart property:

   DRAW_PLOTBACKGROUND
   LEGEND_DRAWBACKGROUND
 

Returns:

The display status of the plot area background for 2D charts.

setBackgroundVisible

public void setBackgroundVisible(boolean b)

Enables/Disables drawing of a background for the chart/legend plot area.

Parameters:

b - The display status for the background.

getBackgroundColor

public java.awt.Color getBackgroundColor()

Returns the color of the chart/legend plot area background.

Associated QbChart property:

   PLOT_BACKGROUNDCOLOR
   LEGEND_BACKGROUNDCOLOR
 

Returns:

The color of the plot area background.

See Also:

isBackgroundVisible()

setBackgroundColor

public void setBackgroundColor(java.awt.Color c)

Sets the color of the chart/legend plot area background.

Parameters:

c - The color value.

getAppearance

public int getAppearance()

Returns the background appearance for the chart/legend plot area.

Associated QbChart property:

   PLOT_BACKGROUND_APPEARANCE
   LEGEND_APPEARANCE
 

Returns:

the background appearance. Valid values are:

   QbChart.RAISE
   QbChart.LOWER
   QbChart.PLAIN
   QbChart.SHADOW
   QbChart.NONE
 

setAppearance

public void setAppearance(int x)

Sets the background appearance for the chart/legend plot area.

Parameters:

x - The background appearance.

See Also:

getAppearance()

getDepth

public int getDepth()

Returns the data plotting area depth.

Associated QbChart property:

   PLOT_BACKGROUND_DEPTH
   LEGEND_DEPTH
 

Returns:

The data plotting area depth

setDepth

public void setDepth(int x)

Sets the data plotting area depth.

Parameters:

x - The data plotting area depth value.

See Also:

getDepth()