com.cete.dynamicpdf.pageelements.charting
Class Axis

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

Direct Known Subclasses:

XAxis, YAxis

public abstract class Axis
extends java.lang.Object

Base class from which x and y-axes are derived.

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

java.lang.String	getLabelFormat() Gets the label list format of the labels.
float	getLabelOffset() Gets the label offset of the axis.
Color	getLineColor() Gets the Color object to use for the line color of the axis.
LineStyle	getLineStyle() Gets the LineStyle object specifying the line style of the axis.
float	getLineWidth() Gets the line width of the axis.
float	getOffset() Gets the offset of the axis.
boolean	isVisible() Gets the visible status of axis.
void	setLabelFormat(java.lang.String labelListFormat) Sets the label list format of the labels.
void	setLabelOffset(float labelOffset) Sets the label offset of the axis.
void	setLineColor(Color lineColor) Sets the Color object to use for the line color of axis.
void	setLineStyle(LineStyle lineStyle) Sets the LineStyle object used to specify the line style of the axis.
void	setLineWidth(float lineWidth) Sets the line width of the axis.
void	setOffset(float offset) Sets the offset of the axis.
void	setVisible(boolean visible) Sets the visible status of axis.

Methods inherited from class java.lang.Object

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

Method Detail

getOffset

public float getOffset()

Gets the offset of the axis.

Returns:

float value specifying offset of the axis.

setOffset

public void setOffset(float offset)

Sets the offset of the axis.

Parameters:

offset - float used to set offset of the axis.

getLineColor

public Color getLineColor()

Gets the Color object to use for the line color of the axis.

Returns:

the Color object specifying the line color of the axis.

See Also:

Color

setLineColor

public void setLineColor(Color lineColor)

Sets the Color object to use for the line color of axis.

Parameters:

lineColor - the Color object used to set the line color of the axis.

See Also:

Color

getLineStyle

public LineStyle getLineStyle()

Gets the LineStyle object specifying the line style of the axis.

Returns:

LineStyle object specifying the line style of the axis.

See Also:

LineStyle

setLineStyle

public void setLineStyle(LineStyle lineStyle)

Sets the LineStyle object used to specify the line style of the axis.

Parameters:

lineStyle - LineStyle object used to set the line style of the axis.

See Also:

LineStyle

getLineWidth

public float getLineWidth()

Gets the line width of the axis.

Returns:

the float value specifying the line width of the axis.

setLineWidth

public void setLineWidth(float lineWidth)

Sets the line width of the axis.

Parameters:

lineWidth - float used to set the line width of the axis.

getLabelOffset

public float getLabelOffset()

Gets the label offset of the axis.

Returns:

the float value specifying the label offset of the axis.

setLabelOffset

public void setLabelOffset(float labelOffset)

Sets the label offset of the axis.

Parameters:

labelOffset - float used to set the label offset of the axis.

isVisible

public boolean isVisible()

Gets the visible status of axis. By default its true.

Returns:

the visible status of axis.

setVisible

public void setVisible(boolean visible)

Sets the visible status of axis. By default its true.

Parameters:

visible - boolean value to set the visible status of axis.

getLabelFormat

public java.lang.String getLabelFormat()

Gets the label list format of the labels.

Returns:

the string value specifying the label list format of the labels.

setLabelFormat

public void setLabelFormat(java.lang.String labelListFormat)

Sets the label list format of the labels.

Parameters:

labelListFormat - string used to set the label list format of the labels.