The requested page is not available for the requested platform. You are viewing the content for Default platform.

AxisBase Class

The base class for all Cartesian Chart's axes.

Declaration

public abstract class AxisBase
extends StyledElement

Remarks

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.

Declaration

public ConstantLineBase[] getConstantLines()

Returns

Type Description
ConstantLineBase[]

An array of ConstantLineBase descendant objects.

getHintOptions() Method

Returns an AxisHintOptions object that defines hint settings.

Declaration

public AxisHintOptions getHintOptions()

Returns

Type Description
AxisHintOptions

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

getLabel() Method

Returns axis label settings.

Declaration

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.

Declaration

public AxisLabelTextFormatter getLabelTextFormatter()

Returns

Type Description
AxisLabelTextFormatter

The object of the class that implements the AxisLabelTextFormatter interface.

getPosition() Method

Returns the axis position.

Declaration

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.

Declaration

public StripBase[] getStrips()

Returns

Type Description
StripBase[]

An array of StripBase descendant objects.

getStyle() Method

Returns the axis style.

Declaration

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.

Declaration

public ChartSynchronizer getSynchronizer()

Returns

Type Description
ChartSynchronizer

The ChartSynchronizer object that is the synchronization marker.

getTitle() Method

Returns the axis title.

Declaration

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.

Declaration

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.

Declaration

public void removeAllConstantLines()

removeAllStrips() Method

Removes all strips from the axis.

Declaration

public void removeAllStrips()

removeConstantLine(int) Method

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

Declaration

public void removeConstantLine(int index)

Parameters

Name Type Description
index int

A constant line's index in the collection.

removeStrip(int) Method

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

Declaration

public void removeStrip(int index)

Parameters

Name Type Description
index int

A strip's index in the collection.

setHintOptions(AxisHintOptions) Method

Specifies an AxisHintOptions object that defines hint settings.

Declaration

public void setHintOptions(AxisHintOptions options)

Parameters

Name Type Description
options AxisHintOptions

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

setLabel(AxisLabel) Method

Specifies axis label settings.

Declaration

public void setLabel(AxisLabel axisLabel)

Parameters

Name Type 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.

Declaration

public void setLabelTextFormatter(AxisLabelTextFormatter formatter)

Parameters

Name Type Description
formatter AxisLabelTextFormatter

The object of the class that implements the AxisLabelTextFormatter interface.

setPosition(AxisPosition) Method

Specifies the axis position.

Declaration

public void setPosition(AxisPosition value)

Parameters

Name Type Description
value AxisPosition

The AxisPosition enumeration value indicating the axis position.

setStyle(AxisStyle) Method

Returns the axis style.

Declaration

public void setStyle(AxisStyle style)

Parameters

Name Type Description
style AxisStyle

The AxisStyle object that specifies axis appearance settings.

setSynchronizer(ChartSynchronizer) Method

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

Declaration

public void setSynchronizer(ChartSynchronizer synchronizer)

Parameters

Name Type Description
synchronizer ChartSynchronizer

The ChartSynchronizer object that is the synchronization marker.

setTitle(AxisTitle) Method

Specifies the axis title.

Declaration

public void setTitle(AxisTitle title)

Parameters

Name Type Description
title AxisTitle

The AxisTitle object that specifies the axis title.

setVisible(boolean) Method

Specifies the value indicating whether the axis is visible.

Declaration

public void setVisible(boolean value)

Parameters

Name Type Description
value boolean

true if the axis should be visible; otherwise false.