com.cete.dynamicpdf.pageelements.charting
Class PlotArea

java.lang.Object
  com.cete.dynamicpdf.pageelements.charting.PlotArea

public class PlotArea
extends java.lang.Object

This can be used to place plot area on the chart.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

Method Summary

void	draw(PageWriter writer) Draws the plot area to the given PageWriter object.
Color	getBackgroundColor() Gets the Color object to use for the background of the plot area.
TitleList	getBottomTitles() Gets the Title object to use for the bottom title of the plot area.
Chart	getChart() Gets the Chart object of the plot area.
boolean	getClipToPlotArea() Gets the boolean value specifying whether to clip data or not.By default its true.
float	getHeight() Gets the height of the plot area.
SeriesList	getSeries() Gets the SeriesList object contained in the plot area.
TitleList	getTopTitles() Gets the Title object to use for the top title of the plot area.
float	getWidth() Gets the width of the plot area.
float	getX() Gets the x coordinate of the plot area.
XAxisList	getXAxes() Gets the XAxesList object contained in the plot area.
float	getY() Gets the y coordinate of the plot area.
YAxisList	getYAxes() Gets the YAxesList object contained in the plot area.
void	setBackgroundColor(Color color) Sets the Color object to use for the background of the plot area.
void	setClipToPlotArea(boolean value) Sets the boolean value specifying whether to clip data or not.
void	setHeight(float height) Sets the height of the plot area.
void	setWidth(float width) Sets the width of the plot area.
void	setX(float x) Sets the x coordinate of the plot area.
void	setY(float y) Sets the y coordinate of the plot area.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getX

public float getX()

Gets the x coordinate of the plot area.

Returns:

the float X coordinate of the plot area.

setX

public void setX(float x)

Sets the x coordinate of the plot area.

Parameters:

x - the float used to set X coordinate of the plot area.

getY

public float getY()

Gets the y coordinate of the plot area.

Returns:

the float Y coordinate of the plot area.

setY

public void setY(float y)

Sets the y coordinate of the plot area.

Parameters:

y - the float used to set Y coordinate of the plot area.

getWidth

public float getWidth()

Gets the width of the plot area.

Returns:

the float width of the plot area.

setWidth

public void setWidth(float width)

Sets the width of the plot area.

Parameters:

width - the float used to set width of plot area.

getHeight

public float getHeight()

Gets the height of the plot area.

Returns:

the float height of the plot area.

setHeight

public void setHeight(float height)

Sets the height of the plot area.

Parameters:

height - the float used to set height of plot area.

getSeries

public SeriesList getSeries()

Gets the SeriesList object contained in the plot area.

Returns:

the series list.

See Also:

SeriesList

getXAxes

public XAxisList getXAxes()

Gets the XAxesList object contained in the plot area.

Returns:

the x-axis list.

See Also:

XAxisList

getYAxes

public YAxisList getYAxes()

Gets the YAxesList object contained in the plot area.

Returns:

the y-axis list.

See Also:

YAxisList

getChart

public Chart getChart()

Gets the Chart object of the plot area.

Returns:

the Chart object.

See Also:

Chart

getBackgroundColor

public Color getBackgroundColor()

Gets the Color object to use for the background of the plot area.

Returns:

the background color of the legend.

See Also:

Color

setBackgroundColor

public void setBackgroundColor(Color color)

Sets the Color object to use for the background of the plot area.

Parameters:

color - Color object used to set the background of the plotarea.

See Also:

Color

getTopTitles

public TitleList getTopTitles()

Gets the Title object to use for the top title of the plot area.

Returns:

the top titles of the plot area.

See Also:

Title

getBottomTitles

public TitleList getBottomTitles()

Gets the Title object to use for the bottom title of the plot area.

Returns:

the bottom titles list.

See Also:

Title

getClipToPlotArea

public boolean getClipToPlotArea()

Gets the boolean value specifying whether to clip data or not.By default its true.

Returns:

the clip to plot area property value.

setClipToPlotArea

public void setClipToPlotArea(boolean value)

Sets the boolean value specifying whether to clip data or not. By default its true.

Parameters:

value - boolean value specifying whether to clip data or not.

draw

public void draw(PageWriter writer)

Draws the plot area to the given PageWriter object.

Parameters:

writer - PageWriter object to receive the plot area's output.

See Also:

PageWriter