Package com.storedobject.chart

Class Axis

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.Axis

All Implemented Interfaces:

ComponentPart, ComponentProperty, VisibleProperty, Wrapped

Direct Known Subclasses:

AngleAxis, RadarAxis, RadiusAxis, XYAxis

public abstract class Axis
extends VisiblePart
implements Wrapped

Abstract representation of an axis.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Axis.AbstractTicks	Represents ticks on an axis line.
static class	Axis.GridAreas	Represents the grid-areas drawn by the axis.
static class	Axis.GridLines	Represents the grid-lines drawn by the axis.
static class	Axis.Label	Represents the label used by Axis.
static class	Axis.Line	A base class for various types of lines used in axis and coordinate systems.
static class	Axis.MinorGridLines	Represents the minor grid-lines drawn by the axis.
static class	Axis.MinorTicks	Represents the minor tick on the axis line.
static class	Axis.Pointer	Represents the axis-pointer shown by the axis.
static class	Axis.PointerHandle	Represent the handle that can be used with an axis-pointer.
static class	Axis.PointerLabel	Represents the label displayed by the axis-pointer.
static enum	Axis.PointerType	Definition of pointer types.
static class	Axis.Ticks	Represents the tick on the axis line.

Constructor Summary

Constructors

Constructor	Description
Axis(AbstractDataProvider<?> data)	Constructor.
Axis(DataType dataType)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
boolean	equals(Object o)
DataType	getDataType()	Get the data type of this axis.
final Axis.GridAreas	getGridAreas(boolean create)	Get the grid-areas for the axis.
final Axis.GridLines	getGridLines(boolean create)	Get the grid-lines of the axis.
final Axis.Label	getLabel(boolean create)	Get the label.
final Axis.MinorGridLines	getMinorGridLines(boolean create)	Get the minor grid-lines of the axis.
final Axis.MinorTicks	getMinorTicks(boolean create)	Get the minor tick of the axis-line.
final String	getName()	Get the name of the axis.
int	getNameGap()	Get the gap between the axis and the name in pixels.
Location	getNameLocation()	Get the location of the name.
int	getNameRotation()	Get the rotation of the name in degrees.
final TextStyle	getNameTextStyle(boolean create)	Get the text style for the name.
final Axis.Pointer	getPointer(boolean create)	Get the axis-pointer for the axis.
int	getRenderingIndex()	Return the rendering index of this part.
final Axis.Ticks	getTicks(boolean create)	Get the axis-line ticks.
int	hashCode()
void	invert()	Invert the axis.
boolean	isAllowEvents()	Determines whether events are allowed on this axis.
void	setAllowEvents(boolean allowEvents)	Sets whether events are allowed on this axis.
void	setData(AbstractDataProvider<?> data)	Set the data for this axis.
void	setDivisions(int divisions)	Set the number of divisions on the axis.
void	setGridAreas(Axis.GridAreas gridAreas)	Set the grid-areas for the axis.
void	setGridLines(Axis.GridLines gridLines)	Set the grid-lines for the axis.
void	setLabel(Axis.Label label)	Set the label for the axis.
void	setMax(Object max)	Set the maximum value for the axis.
void	setMaxAsMaxData()	By invoking this method, the maximum of the axis will be set as the maximum value of the data.
void	setMin(Number min)	Set the minimum value for the axis.
void	setMinAsMinData()	By invoking this method, the minimum of the axis will be set as the minimum value of the data.
void	setMinorGridLines(Axis.MinorGridLines gridLines)	Set the minor grid-lines for the axis.
void	setMinorTicks(Axis.MinorTicks ticks)	Set the minor of the axis-line.
void	setName(String name)	Set the name of the axis.
void	setNameGap(int nameGap)	Set the gap between the axis and the name in pixels.
void	setNameLocation(Location nameLocation)	Set the location of the name.
void	setNameRotation(int nameRotation)	Set the rotation of the name in degrees.
void	setNameTextStyle(TextStyle nameTextStyle)	Set the text style or the name.
void	setPointer(Axis.Pointer pointer)	Set the axis-pointer for this axis.
void	setRenderingIndex(int renderingIndex)	Set the rendering index of this part.
void	setTicks(Axis.Ticks ticks)	Set the axis-line ticks.
void	showZeroPosition(boolean show)	Set whether zero positions to be shown or not.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible

Methods inherited from class com.storedobject.chart.AbstractPart

getId, getLabelTag, getSerial, getZ, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

Axis

public Axis(DataType dataType)

Constructor.

Parameters:

dataType - Axis data type.

Axis

public Axis(AbstractDataProvider<?> data)

Constructor.

Parameters:

data - Data type will be determined from the data provider.

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractPart

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractPart

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class VisiblePart

Throws:

ChartException - Raises exception if the component or part is not valid.

setData

public void setData(AbstractDataProvider<?> data)

Set the data for this axis.

Note: Normally, this is not required to be set unless you are working on a custom chart that is not yet supported.

Parameters:

data - Data to be used for this axis.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

setAllowEvents

public void setAllowEvents(boolean allowEvents)

Sets whether events are allowed on this axis.

Parameters:

allowEvents - True to allow events, false to disable them.

isAllowEvents

public boolean isAllowEvents()

Determines whether events are allowed on this axis.

Returns:

True if events are allowed, false otherwise.

setRenderingIndex

public void setRenderingIndex(int renderingIndex)

Description copied from interface: ComponentPart

Set the rendering index of this part. Rendering index is the position of this part on the chart when it is being rendered. It is up to the part to keep this value if required.

Specified by:

setRenderingIndex in interface ComponentPart

Parameters:

renderingIndex - Rendering index.

getRenderingIndex

public int getRenderingIndex()

Description copied from interface: ComponentPart

Return the rendering index of this part. The default implementation returns -1.

Specified by:

getRenderingIndex in interface ComponentPart

Returns:

Rendering index.

getName

public final String getName()

Get the name of the axis.

Specified by:

getName in interface ComponentPart

Overrides:

getName in class AbstractPart

Returns:

Name of the axis.

setName

public void setName(String name)

Set the name of the axis.

Specified by:

setName in interface ComponentPart

Parameters:

name - Name to set.

invert

public void invert()

Invert the axis. If called, the drawing of the axis will be inverted (drawn in the opposite direction).

getNameGap

public int getNameGap()

Get the gap between the axis and the name in pixels. (It can have negative values).

Returns:

Gap in pixels.

setNameGap

public void setNameGap(int nameGap)

Set the gap between the axis and the name in pixels. (It can have negative values).

Parameters:

nameGap - Gap in pixels.

getNameRotation

public int getNameRotation()

Get the rotation of the name in degrees.

Returns:

Rotation.

setNameRotation

public void setNameRotation(int nameRotation)

Set the rotation of the name in degrees.

Parameters:

nameRotation - Rotation.

getNameLocation

public Location getNameLocation()

Get the location of the name.

Returns:

Location of the name.

setNameLocation

public void setNameLocation(Location nameLocation)

Set the location of the name.

Parameters:

nameLocation - Location to set.

getNameTextStyle

public final TextStyle getNameTextStyle(boolean create)

Get the text style for the name.

Parameters:

create - Whether to create if not exists or not.

Returns:

Text style.

setNameTextStyle

public void setNameTextStyle(TextStyle nameTextStyle)

Set the text style or the name.

Parameters:

nameTextStyle - Text style to set.

setMin

public void setMin(Number min)

Set the minimum value for the axis.

Parameters:

min - Minimum value. (For category axis, it could be just an ordinal number of the categories). Note: The type of the value must be compatible with the data type of the axis. Otherwise, it will be ignored.

setMinAsMinData

public void setMinAsMinData()

By invoking this method, the minimum of the axis will be set as the minimum value of the data.

setMax

public void setMax(Object max)

Set the maximum value for the axis.

Parameters:

max - Maximum value. (For category axis, it could be just an ordinal number of the categories). Note: The type of the value must be compatible with the data type of the axis. Otherwise, it will be ignored.

setMaxAsMaxData

public void setMaxAsMaxData()

By invoking this method, the maximum of the axis will be set as the maximum value of the data.

setDivisions

public void setDivisions(int divisions)

Set the number of divisions on the axis. This will be used as a hint only because for actual divisions will be determined based on the readability too. Also, this is not applicable to category type axes.

Parameters:

divisions - Number of divisions.

showZeroPosition

public void showZeroPosition(boolean show)

Set whether zero positions to be shown or not. On certain charts, it may be required not to show zero positions of the axis. Note: this setting is ignored if minimum and maximum values are already set. Also, this is not applicable to category type axes.

Parameters:

show - True or false.

getLabel

public final Axis.Label getLabel(boolean create)

Get the label.

Parameters:

create - Whether to create if not exists or not.

Returns:

Label.

setLabel

public void setLabel(Axis.Label label)

Set the label for the axis.

Parameters:

label - Label.

getTicks

public final Axis.Ticks getTicks(boolean create)

Get the axis-line ticks.

Parameters:

create - Whether to create if not exists or not.

Returns:

Tick.

setTicks

public void setTicks(Axis.Ticks ticks)

Set the axis-line ticks.

Parameters:

ticks - Ticks.

getMinorTicks

public final Axis.MinorTicks getMinorTicks(boolean create)

Get the minor tick of the axis-line.

Parameters:

create - Whether to create if not exists or not.

Returns:

Minor ticks.

setMinorTicks

public void setMinorTicks(Axis.MinorTicks ticks)

Set the minor of the axis-line.

Parameters:

ticks - Minor ticks.

getGridLines

public final Axis.GridLines getGridLines(boolean create)

Get the grid-lines of the axis.

Parameters:

create - Whether to create if not exists or not.

Returns:

Grid-lines.

setGridLines

public void setGridLines(Axis.GridLines gridLines)

Set the grid-lines for the axis.

Parameters:

gridLines - Grid-lines to set.

getMinorGridLines

public final Axis.MinorGridLines getMinorGridLines(boolean create)

Get the minor grid-lines of the axis.

Parameters:

create - Whether to create if not exists or not.

Returns:

Grid-lines.

setMinorGridLines

public void setMinorGridLines(Axis.MinorGridLines gridLines)

Set the minor grid-lines for the axis.

Parameters:

gridLines - Grid-lines to set.

getGridAreas

public final Axis.GridAreas getGridAreas(boolean create)

Get the grid-areas for the axis.

Parameters:

create - Whether to create if not exists or not.

Returns:

Grid-areas.

setGridAreas

public void setGridAreas(Axis.GridAreas gridAreas)

Set the grid-areas for the axis.

Parameters:

gridAreas - Grid-areas to set.

getPointer

public final Axis.Pointer getPointer(boolean create)

Get the axis-pointer for the axis. (By default, no axis-pointer will be shown. However, if a call is made to this method with create = true, an axis-pointer will be made visible. Then, you may use the VisibleProperty.hide() method to hide it if required.)

Parameters:

create - Whether to create if not exists or not.

Returns:

Axis-pointer.

setPointer

public void setPointer(Axis.Pointer pointer)

Set the axis-pointer for this axis.

Parameters:

pointer - Axis-pointer.

getDataType

public DataType getDataType()

Get the data type of this axis.

Returns:

Data type.