AxisBase Class

The base class for all Cartesian Chart's axes.

Syntax

public abstract class AxisBase
extends StyledElement

This class introduces axis elements that the following image represents:

Axis elements

Note that the axis style controls tickmarks, gridlines and interlacing visibility.

Inheritance

Inherited Members

java.lang.Object.equals(java.lang.Object)
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long, int)

Methods

getConstantLines() Method

Returns an array of constant lines which the axis contains.

Syntax

public ConstantLineBase[] getConstantLines()

Returns

Type Description
ConstantLineBase[]

An array of ConstantLineBase descendant objects.

getHintOptions() Method

Returns an AxisHintOptions object that defines hint settings.

Syntax

public AxisHintOptions getHintOptions()

Returns

Type Description
AxisHintOptions

The AxisHintOptions object that specifies hint settings related to the axis.

getLabel() Method

Returns axis label settings.

Syntax

public AxisLabel getLabel()

Returns

Type Description
AxisLabel

The AxisLabel object that configures axis labels' appearance, position, content, and visibility.

getLabelTextFormatter() Method

Returns the formatter that provides axis labels' values.

Syntax

public AxisLabelTextFormatter getLabelTextFormatter()

Returns

Type Description
AxisLabelTextFormatter

The object of the class that implements the AxisLabelTextFormatter interface.

getPosition() Method

Returns the axis position.

Syntax

public AxisPosition getPosition()

Returns

Type Description
AxisPosition

The AxisPosition enumeration value indicating the axis position.

getStrips() Method

Returns an array of strips which the axis contains.

Syntax

public StripBase[] getStrips()

Returns

Type Description
StripBase[]

An array of StripBase descendant objects.

getStyle() Method

Returns the axis style.

Syntax

public AxisStyle getStyle()

Returns

Type Description
AxisStyle

The AxisStyle object that specifies axis appearance settings.

getSynchronizer() Method

Returns a ChartSynchronizer object that indicates that the axis range should be synchronized.

Syntax

public ChartSynchronizer getSynchronizer()

Returns

Type Description
ChartSynchronizer

The ChartSynchronizer object that is the synchronization marker.

getTitle() Method

Returns the axis title.

Syntax

public AxisTitle getTitle()

Returns

Type Description
AxisTitle

The AxisTitle object that stores title settings.

isVisible() Method

Returns the value indicating whether the axis is visible.

Syntax

public boolean isVisible()

Returns

Type Description
boolean

true if the axis should be visible; otherwise false.

removeAllConstantLines() Method

Removes all constant lines from the axis.

Syntax

public void removeAllConstantLines()

removeAllStrips() Method

Removes all strips from the axis.

Syntax

public void removeAllStrips()

removeConstantLine(int) Method

Removes the constant line at the specified index from the axis constant line collection.

Syntax

public void removeConstantLine(int index)

Parameters

Type Name Description
int index

A constant line's index in the collection.

removeStrip(int) Method

Removes the strip at the specified index from the axis strip collection.

Syntax

public void removeStrip(int index)

Parameters

Type Name Description
int index

A strip's index in the collection.

setHintOptions(AxisHintOptions) Method

Specifies an AxisHintOptions object that defines hint settings.

Syntax

public void setHintOptions(AxisHintOptions options)

Parameters

Type Name Description
AxisHintOptions options

The AxisHintOptions object that specifies hint settings related to the axis.

setLabel(AxisLabel) Method

Specifies axis label settings.

Syntax

public void setLabel(AxisLabel axisLabel)

Parameters

Type Name Description
AxisLabel axisLabel

The AxisLabel object that configures axis labels' appearance, position, content, and visibility.

setLabelTextFormatter(AxisLabelTextFormatter) Method

Specifies the formatter that provides axis labels' text.

Syntax

public void setLabelTextFormatter(AxisLabelTextFormatter formatter)

Parameters

Type Name Description
AxisLabelTextFormatter formatter

The object of the class that implements the AxisLabelTextFormatter interface.

setPosition(AxisPosition) Method

Specifies the axis position.

Syntax

public void setPosition(AxisPosition value)

Parameters

Type Name Description
AxisPosition value

The AxisPosition enumeration value indicating the axis position.

setStyle(AxisStyle) Method

Returns the axis style.

Syntax

public void setStyle(AxisStyle style)

Parameters

Type Name Description
AxisStyle style

The AxisStyle object that specifies axis appearance settings.

setSynchronizer(ChartSynchronizer) Method

Specifies a ChartSynchronizer object that indicates if the axis range should be synchronized.

Syntax

public void setSynchronizer(ChartSynchronizer synchronizer)

Parameters

Type Name Description
ChartSynchronizer synchronizer

The ChartSynchronizer object that is the synchronization marker.

setTitle(AxisTitle) Method

Specifies the axis title.

Syntax

public void setTitle(AxisTitle title)

Parameters

Type Name Description
AxisTitle title

The AxisTitle object that specifies the axis title.

setVisible(boolean) Method

Specifies the value indicating whether the axis is visible.

Syntax

public void setVisible(boolean value)

Parameters

Type Name Description
boolean value

true if the axis should be visible; otherwise false.