org.jplot2d.element

Interface Axis

All Superinterfaces:

Element, PComponent

All Known Subinterfaces:

AxisEx

All Known Implementing Classes:

AxisImpl

public interface Axis
extends PComponent

Method Summary

Modifier and Type	Method and Description
float	getAxisLineWidth() Returns the axis line width is pt(1/72 inch)
java.awt.Color	getLabelColor() Return the color of the labels of the ticks
AxisOrientation	getLabelOrientation() Get the Orientation of the labels.
AxisLabelSide	getLabelSide() Return the position of the label of the ticks
double	getLength() Returns the paper length of this axis.
double	getMinorTickHeight() Return the height of the minor ticks of the axis.
AxisOrientation	getOrientation() Orientation is a read-only property.
Plot	getParent() Gets the parent of this component.
AxisPosition	getPosition() Return the position of the axis: NEGATIVE_SIDE, POSITIVE_SIDE.
double	getTickHeight() Returns the height of the major ticks of the axis
float	getTickLineWidth() Returns the axis line width is pt(1/72 inch)
AxisTickManager	getTickManager() Returns the tick manager of this axis.
AxisTickSide	getTickSide() Return the direction of the ticks
AxisTitle	getTitle() Returns the title of this axis.
boolean	isGridLines() Return if the grid line is displayed or not.
boolean	isLabelVisible() Returns if the tick labels is shown or not
boolean	isMinorGridLines() Return if the minor grid line is displayed or not.
boolean	isTickVisible() Returns if the tick mark is shown or not
void	setAxisLineWidth(float width) Sets the axis line width is pt(1/72 inch).
void	setGridLines(boolean showGridLines) Sets grid lines of grey lines in corresponding of major ticks of the axis.
void	setLabelColor(java.awt.Color color) Set the color of the labels of the ticks
void	setLabelOrientation(AxisOrientation orientation) Set the orientation of the labels of the ticks
void	setLabelSide(AxisLabelSide side) Set the position of the label of the ticks respect of the axis
void	setLabelVisible(boolean visible) Sets if the tick labels is shown or not
void	setMinorGridLines(boolean showGridLines) Sets grid lines of grey lines in corresponding of minor ticks of the axis.
void	setMinorTickHeight(double height) Set the height of the minor ticks of the axis.
void	setPosition(AxisPosition position) Set the position of the axis: NEGATIVE_SIDE, POSITIVE_SIDE.
void	setTickHeight(double height) Set the height of the major ticks of the axis.
void	setTickLineWidth(float width) Sets the axis line width is pt(1/72 inch).
void	setTickManager(AxisTickManager tickManager)
void	setTickSide(AxisTickSide side) Set the side position of the ticks
void	setTickVisible(boolean visible) Sets if the tick mark is shown or not

Methods inherited from interface org.jplot2d.element.PComponent

getBounds, getColor, getEffectiveFont, getFontName, getFontScale, getFontSize, getFontStyle, getLocation, getPaperTransform, getSelectableBounds, getSize, getZOrder, isCacheable, isSelectable, isVisible, setCacheable, setColor, setFont, setFontName, setFontScale, setFontSize, setFontStyle, setSelectable, setVisible, setZOrder

Methods inherited from interface org.jplot2d.element.Element

getEnvironment, getId

Method Detail

getParent

Plot getParent()

Description copied from interface: PComponent

Gets the parent of this component.

Specified by:

getParent in interface Element

Specified by:

getParent in interface PComponent

Returns:

the parent of this component

getTitle

AxisTitle getTitle()

Returns the title of this axis.

Returns:

the title of this axis

getTickManager

AxisTickManager getTickManager()

Returns the tick manager of this axis.

Returns:

the tick manager of this axis

setTickManager

void setTickManager(AxisTickManager tickManager)

getOrientation

AxisOrientation getOrientation()

Orientation is a read-only property. It just show the orientation of this axis after it has been add as a X/Y axis.

Returns:

orientation of this axis

getLength

double getLength()

Returns the paper length of this axis.

Returns:

the paper length

getPosition

AxisPosition getPosition()

Return the position of the axis: NEGATIVE_SIDE, POSITIVE_SIDE.

Returns:

the position of the axis in the plot.

setPosition

void setPosition(AxisPosition position)

Set the position of the axis: NEGATIVE_SIDE, POSITIVE_SIDE.

Parameters:

position - the position of the axis in the plot.

getAxisLineWidth

float getAxisLineWidth()

Returns the axis line width is pt(1/72 inch)

Returns:

the axis line width

setAxisLineWidth

void setAxisLineWidth(float width)

Sets the axis line width is pt(1/72 inch). The default line width is 1.0 pt.

Parameters:

width - the axis line width

isGridLines

boolean isGridLines()

Return if the grid line is displayed or not.

Returns:

true if the grid line is displayed

setGridLines

void setGridLines(boolean showGridLines)

Sets grid lines of grey lines in corresponding of major ticks of the axis.

Parameters:

showGridLines - if true show the grid lines.

isMinorGridLines

boolean isMinorGridLines()

Return if the minor grid line is displayed or not.

Returns:

true if the minor grid line is displayed

setMinorGridLines

void setMinorGridLines(boolean showGridLines)

Sets grid lines of grey lines in corresponding of minor ticks of the axis.

Parameters:

showGridLines - if true show the grid lines.

isTickVisible

boolean isTickVisible()

Returns if the tick mark is shown or not

Returns:

if the tick mark is shown or not

setTickVisible

void setTickVisible(boolean visible)

Sets if the tick mark is shown or not

Parameters:

visible -

getTickSide

AxisTickSide getTickSide()

Return the direction of the ticks

setTickSide

void setTickSide(AxisTickSide side)

Set the side position of the ticks

getTickHeight

double getTickHeight()

Returns the height of the major ticks of the axis

Returns:

the height of the ticks

setTickHeight

void setTickHeight(double height)

Set the height of the major ticks of the axis.

Parameters:

height - the new height of the ticks

getMinorTickHeight

double getMinorTickHeight()

Return the height of the minor ticks of the axis.

Returns:

the height of the minor ticks.

setMinorTickHeight

void setMinorTickHeight(double height)

Set the height of the minor ticks of the axis.

Parameters:

height - the height of the ticks

getTickLineWidth

float getTickLineWidth()

Returns the axis line width is pt(1/72 inch)

Returns:

the axis line width

setTickLineWidth

void setTickLineWidth(float width)

Sets the axis line width is pt(1/72 inch). The default line width is 0.5 pt.

Parameters:

width - the axis line width

isLabelVisible

boolean isLabelVisible()

Returns if the tick labels is shown or not

Returns:

if the tick mark is shown or not

setLabelVisible

void setLabelVisible(boolean visible)

Sets if the tick labels is shown or not

Parameters:

visible -

getLabelSide

AxisLabelSide getLabelSide()

Return the position of the label of the ticks

setLabelSide

void setLabelSide(AxisLabelSide side)

Set the position of the label of the ticks respect of the axis

getLabelOrientation

AxisOrientation getLabelOrientation()

Get the Orientation of the labels.

Returns:

label orientation:
0 HORIZONTAL
1 VERTICAL

setLabelOrientation

void setLabelOrientation(AxisOrientation orientation)

Set the orientation of the labels of the ticks

Parameters:

orientation - HORIZONTAL/VERTICAL

getLabelColor

java.awt.Color getLabelColor()

Return the color of the labels of the ticks

Returns:

the color of the labels

setLabelColor

void setLabelColor(java.awt.Color color)

Set the color of the labels of the ticks

Parameters:

color - the color of the labels