Package com.amalgamasimulation.charts.axes

Class BarChartCategoryXAxis

java.lang.Object

com.amalgamasimulation.charts.axes.AbstractAxis<Number>

com.amalgamasimulation.charts.axes.BarChartCategoryXAxis

All Implemented Interfaces:

IGetDisplayedRangePropertyOwner, IScrollBarPropertyOwner

public class BarChartCategoryXAxis
extends AbstractAxis<Number>
implements IScrollBarPropertyOwner, IGetDisplayedRangePropertyOwner

Class that represents an X-axis drawn on a BarChart or HistogramChart area. The X-axis tick labels represents the names of the visual set data elements. It holds properties for axis ticks and labels along the axis. This axis does not allow ranging, zoom or pan operations.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal	chartInternal
protected com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal	xAxisInternal

Constructor Summary

Constructors

Constructor	Description
BarChartCategoryXAxis(com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal, com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal xAxisInternal)	Constructs a BarChartInternal X-axis with given BarXAxisInternal

Method Summary

Modifier and Type	Method	Description
BarChartCategoryXAxis	addDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Adds the action to be executed every time the displayed range changed.
BarChartCategoryXAxis	clearDisplayedRangeChangeHandler()	Clear all the displayed range changed actions.
protected com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal	getAxisInternal()
protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal	getChartInternal()
Pair<Double,Double>	getDisplayedRange()	Returns the currently displayed values range of axis.
boolean	isScrollBarDisplayed()	Checks whether the scrollbar is currently displayed.
boolean	isScrollBarVisible()	Checks whether the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible.
BarChartCategoryXAxis	removeDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Removes the displayed range changed action.
BarChartCategoryXAxis	setLabelsFormat(Function<Double,String> format)	Sets the formatter to axis labels, i.e.
BarChartCategoryXAxis	setScrollBarVisible(boolean visible)	Specifies whether the scrollbar should be drawn if scrolling the displayed rang of axis is possible.

Methods inherited from class com.amalgamasimulation.charts.axes.AbstractAxis

getLabelsColor, getLabelsFont, getLabelsFontSize, setGridLinesColor, setGridLinesColor, setGridLinesVisible, setGridLinesWidth, setLabelsColor, setLabelsColor, setLabelsFont, setLabelsFontSize

Methods inherited from class java.lang.Object

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

Field Details

chartInternal

protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal

xAxisInternal

protected com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal xAxisInternal

Constructor Details

BarChartCategoryXAxis

public BarChartCategoryXAxis(com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal chartInternal,
 com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal xAxisInternal)

Constructs a BarChartInternal X-axis with given BarXAxisInternal

Parameters:

chartInternal - BarChartInternal which is the owner of this object

xAxisInternal - BarXAxisInternal which is the internal axis logic aggregator

Method Details

setLabelsFormat

public BarChartCategoryXAxis setLabelsFormat(Function<Double,String> format)

Sets the formatter to axis labels, i.e. the function that takes a Double value and produces a String that should be drawn to represent this value.

Parameters:

format - new axis labels formatter

Returns:

reference to this object

getDisplayedRange

public Pair<Double,Double> getDisplayedRange()

Description copied from interface: IGetDisplayedRangePropertyOwner

Returns the currently displayed values range of axis.

Specified by:

getDisplayedRange in interface IGetDisplayedRangePropertyOwner

Returns:

the pair contains minimum and maximum values of the currently displayed range

setScrollBarVisible

public BarChartCategoryXAxis setScrollBarVisible(boolean visible)

Description copied from interface: IScrollBarPropertyOwner

Specifies whether the scrollbar should be drawn if scrolling the displayed rang of axis is possible. True by default. If set to false, the scrollbar will never be drawn but the functionality of scrolling this axis will still remain. Redraws this axis and it's parent chart if visibility is changed.

Specified by:

setScrollBarVisible in interface IScrollBarPropertyOwner

Parameters:

visible - flag setting if the scrollbar should be drawn if scrolling the displayed rang of axis is possible

Returns:

reference to this object

See Also:

• Chart.redraw()

isScrollBarVisible

public boolean isScrollBarVisible()

Description copied from interface: IScrollBarPropertyOwner

Checks whether the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible.

Specified by:

isScrollBarVisible in interface IScrollBarPropertyOwner

Returns:

true if the scrollbar should be drawn if scrolling the displayed rang of Y-axis is possible, false otherwise

isScrollBarDisplayed

public boolean isScrollBarDisplayed()

Description copied from interface: IScrollBarPropertyOwner

Checks whether the scrollbar is currently displayed.

Specified by:

isScrollBarDisplayed in interface IScrollBarPropertyOwner

Returns:

true if the scrollbar is currently displayed, false otherwise

addDisplayedRangeChangeHandler

public BarChartCategoryXAxis addDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)

Description copied from interface: IGetDisplayedRangePropertyOwner

Adds the action to be executed every time the displayed range changed.

Specified by:

addDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Parameters:

handler - new displayed range changed action

Returns:

reference to this object

removeDisplayedRangeChangeHandler

public BarChartCategoryXAxis removeDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)

Description copied from interface: IGetDisplayedRangePropertyOwner

Removes the displayed range changed action.

Specified by:

removeDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Parameters:

handler - removed displayed range changed action

Returns:

reference to this object

clearDisplayedRangeChangeHandler

public BarChartCategoryXAxis clearDisplayedRangeChangeHandler()

Description copied from interface: IGetDisplayedRangePropertyOwner

Clear all the displayed range changed actions.

Specified by:

clearDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Returns:

reference to this object

getChartInternal

protected com.amalgamasimulation.charts.internals.charts.AbstractBarChartInternal getChartInternal()

Specified by:

getChartInternal in class AbstractAxis<Number>

getAxisInternal

protected com.amalgamasimulation.charts.internals.axes.AbstractBarXAxisInternal getAxisInternal()

Specified by:

getAxisInternal in class AbstractAxis<Number>