Package com.amalgamasimulation.charts.axes

Class LineChartNumericYAxis

java.lang.Object

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

com.amalgamasimulation.charts.axes.LineChartNumericYAxis

All Implemented Interfaces:

IAutoAdjustmentPropertyOwner, IAxisTitlePositionPropertyOwner, IAxisTitlePropertyOwner<Number>, IGetDisplayedRangePropertyOwner, IMaxValuePropertyOwner, IMinMaxValuePropertyOwner, IMinValuePropertyOwner, INumericStylePropertyOwner, IValueInRangePropertyOwner, IZeroGridLinePropertyOwner

public class LineChartNumericYAxis
extends AbstractAxis<Number>
implements IMinMaxValuePropertyOwner, IGetDisplayedRangePropertyOwner, INumericStylePropertyOwner, IValueInRangePropertyOwner, IAutoAdjustmentPropertyOwner, IAxisTitlePropertyOwner<Number>, IZeroGridLinePropertyOwner, IAxisTitlePositionPropertyOwner

Class that represents an Y-axis drawn on a NumericLineChart area. It holds properties for ticks and labels along the axis. The Y-axis tick labels represents the numeric values of the visual set data elements. This axis does allow ranging operations.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected com.amalgamasimulation.charts.internals.charts.LineChartInternal	chartInternal
protected com.amalgamasimulation.charts.internals.axes.NumericLineChartYAxisInternal	yAxisInternal

Constructor Summary

Constructors

Constructor	Description
LineChartNumericYAxis(com.amalgamasimulation.charts.internals.charts.LineChartInternal chartInternal, com.amalgamasimulation.charts.internals.axes.NumericLineChartYAxisInternal yAxisInternal)	Constructs a LineChartInternal X-axis with given NumericLineChartYAxisInternal

Method Summary

Modifier and Type	Method	Description
LineChartNumericYAxis	addDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Adds the action to be executed every time the displayed range changed.
LineChartNumericYAxis	clearDisplayedRangeChangeHandler()	Clear all the displayed range changed actions.
protected com.amalgamasimulation.charts.internals.axes.NumericLineChartYAxisInternal	getAxisInternal()
protected com.amalgamasimulation.charts.internals.charts.LineChartInternal	getChartInternal()
Pair<Double,Double>	getDisplayedRange()	Returns the currently displayed values range of axis.
double	getMaxValue()	Returns the maximum possible value that can be displayed on axis.
double	getMinValue()	Returns the minimum possible value that can be displayed on axis.
String	getTitle()	Returns the title of this axis, or null if title has not been specified.
javafx.scene.paint.Color	getTitleColor()	Returns the color of this axis title.
javafx.scene.text.Font	getTitleFont()	Returns the font of this axis title.
int	getTitleFontSize()	Returns the font size of this axis title.
AxisTitlePosition	getTitlePosition()	Returns the AxisTitlePosition that specifies the the chart's title position.
javafx.scene.paint.Color	getZeroGridLineColor()	Returns the color of the zero grid line.
int	getZeroGridLineWidth()	Returns the width of the zero grid line, in pixels.
boolean	isDisplayedRangeMaxValueAutoAdjustmentEnabled()	Checks whether the maximum value is equal to the maximum value of the currently displayed contents.
boolean	isDisplayedRangeMinValueAutoAdjustmentEnabled()	Checks whether the minimum value is equal to the minimum value of the currently displayed contents.
boolean	isTitleVisible()	Checks whether this axis title should be drawn.
boolean	isValueDisplayed(double value)	Checks whether the value is displayed on this axis.
boolean	isZeroGridLineVisible()	Checks whether the zero grid line is visible.
boolean	isZeroInDisplayedRange()	Checks whether zero is always exists in the displayed range.
LineChartNumericYAxis	removeDisplayedRangeChangeHandler(BiConsumer<Double,Double> handler)	Removes the displayed range changed action.
LineChartNumericYAxis	setDisplayedRangeMaxValueAutoAdjustmentEnabled(boolean enabled)	Specifies an axis mode in which the maximum axis value is equal to the maximum value of the currently displayed contents.
LineChartNumericYAxis	setDisplayedRangeMinValueAutoAdjustmentEnabled(boolean enabled)	Specifies an axis mode in which the minimum axis value is equal to the minimum value of the currently displayed contents.
LineChartNumericYAxis	setLabelsFormat(Function<Double,String> format)	Sets the formatter to axis labels, i.e.
LineChartNumericYAxis	setMaxValue(double value)	Sets the maximum possible value that can be displayed on axis.
IAutoAdjustmentPropertyOwner	setMinAdjustedDisplayedRange(double minAdjustRange)	Specifies minimum axis range of the currently displayed contents.
LineChartNumericYAxis	setMinValue(double value)	Sets the minimum possible value that can be displayed on axis.
LineChartNumericYAxis	setNumericStyle(AxisNumericStyle style)	Sets the AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values.
LineChartNumericYAxis	setTitle(String title)	Sets the new title to this axis.
LineChartNumericYAxis	setTitleColor(Color color)	Sets the new color to this axis title.
LineChartNumericYAxis	setTitleColor(javafx.scene.paint.Color color)	Sets the new color to this axis title.
LineChartNumericYAxis	setTitleFont(javafx.scene.text.Font font)	Sets the new font to this axis title.
LineChartNumericYAxis	setTitleFontSize(int fontSize)	Sets the new font size to this axis title.
LineChartNumericYAxis	setTitlePosition(AxisTitlePosition yAxisTitlePosition)	Sets the AxisTitlePosition that specifies the chart's title position.
LineChartNumericYAxis	setTitleVisible(boolean visible)	Specifies whether this axis title should be drawn.
LineChartNumericYAxis	setValueLimits(double minValue, double maxValue)	Convenience method, can be used instead of calling two methods setMinValue and setMaxValue.
LineChartNumericYAxis	setZeroGridLineColor(Color color)	Sets the new color to the zero grid line of this chart.
LineChartNumericYAxis	setZeroGridLineColor(javafx.scene.paint.Color color)	Sets the new color to the zero grid line of this chart.
LineChartNumericYAxis	setZeroGridLineVisible(boolean visible)	Specifies whether the zero grid line should be drawn.
LineChartNumericYAxis	setZeroGridLineWidth(int width)	Sets the new width to the zero grid line of this chart, in pixels.
LineChartNumericYAxis	setZeroInDisplayedRange(boolean showZero)	Specifies an axis mode in which zero value is always exists in the displayed range.

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.LineChartInternal chartInternal

yAxisInternal

protected com.amalgamasimulation.charts.internals.axes.NumericLineChartYAxisInternal yAxisInternal

Constructor Details

LineChartNumericYAxis

public LineChartNumericYAxis(com.amalgamasimulation.charts.internals.charts.LineChartInternal chartInternal,
 com.amalgamasimulation.charts.internals.axes.NumericLineChartYAxisInternal yAxisInternal)

Constructs a LineChartInternal X-axis with given NumericLineChartYAxisInternal

Parameters:

chartInternal - LineChartInternal which is the owner of this object

yAxisInternal - NumericLineChartYAxisInternal which is the internal axis logic aggregator

Method Details

getChartInternal

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

Specified by:

getChartInternal in class AbstractAxis<Number>

getAxisInternal

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

Specified by:

getAxisInternal in class AbstractAxis<Number>

getTitlePosition

public AxisTitlePosition getTitlePosition()

Description copied from interface: IAxisTitlePositionPropertyOwner

Returns the AxisTitlePosition that specifies the the chart's title position.

Specified by:

getTitlePosition in interface IAxisTitlePositionPropertyOwner

Returns:

this current AxisTitlePosition

setTitlePosition

public LineChartNumericYAxis setTitlePosition(AxisTitlePosition yAxisTitlePosition)

Description copied from interface: IAxisTitlePositionPropertyOwner

Sets the AxisTitlePosition that specifies the chart's title position. Redraws this axis and it's parent chart.

Specified by:

setTitlePosition in interface IAxisTitlePositionPropertyOwner

Parameters:

yAxisTitlePosition - new AxisTitlePosition that specifies the chart's title position

Returns:

reference to this object

setMinValue

public LineChartNumericYAxis setMinValue(double value)

Description copied from interface: IMinValuePropertyOwner

Sets the minimum possible value that can be displayed on axis. The displayed range of axis cannot include values less than the specified value. Scrolling of axis is limited accordingly. Redraws this axis and it's parent chart.

Specified by:

setMinValue in interface IMinValuePropertyOwner

Parameters:

value - minimum possible value that can be displayed on axis

Returns:

reference to this object

setMaxValue

public LineChartNumericYAxis setMaxValue(double value)

Description copied from interface: IMaxValuePropertyOwner

Sets the maximum possible value that can be displayed on axis. The displayed range of axis cannot include values more than the specified value. Scrolling of axis is limited accordingly. Redraws this axis and it's parent chart.

Specified by:

setMaxValue in interface IMaxValuePropertyOwner

Parameters:

value - maximum possible value that can be displayed on axis

Returns:

reference to this object

isValueDisplayed

public boolean isValueDisplayed(double value)

Description copied from interface: IValueInRangePropertyOwner

Checks whether the value is displayed on this axis.

Specified by:

isValueDisplayed in interface IValueInRangePropertyOwner

Parameters:

value - value to check

Returns:

true if the value is displayed on this axis, false otherwise

getMinValue

public double getMinValue()

Description copied from interface: IMinValuePropertyOwner

Returns the minimum possible value that can be displayed on axis.

Specified by:

getMinValue in interface IMinValuePropertyOwner

Returns:

the minimum possible value that can be displayed on axis

getMaxValue

public double getMaxValue()

Description copied from interface: IMaxValuePropertyOwner

Returns the maximum possible value that can be displayed on axis.

Specified by:

getMaxValue in interface IMaxValuePropertyOwner

Returns:

the maximum possible value that can be displayed on axis

setValueLimits

public LineChartNumericYAxis setValueLimits(double minValue,
 double maxValue)

Description copied from interface: IMinMaxValuePropertyOwner

Convenience method, can be used instead of calling two methods setMinValue and setMaxValue. Redraws this axis and it's parent chart.

Specified by:

setValueLimits in interface IMinMaxValuePropertyOwner

Parameters:

minValue - minimum possible value that can be displayed on axis

maxValue - maximum possible value that can be displayed on axis

Returns:

reference to this object

setMinAdjustedDisplayedRange

public IAutoAdjustmentPropertyOwner setMinAdjustedDisplayedRange(double minAdjustRange)

Description copied from interface: IAutoAdjustmentPropertyOwner

Specifies minimum axis range of the currently displayed contents. Redraws this chart if value is changed.

Specified by:

setMinAdjustedDisplayedRange in interface IAutoAdjustmentPropertyOwner

Parameters:

minAdjustRange - minimum axis range of the currently displayed contents

Returns:

reference to this object

See Also:

• Chart.redraw()

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

setNumericStyle

public LineChartNumericYAxis setNumericStyle(AxisNumericStyle style)

Description copied from interface: INumericStylePropertyOwner

Sets the AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values.

Specified by:

setNumericStyle in interface INumericStylePropertyOwner

Parameters:

style - new AxisNumericStyle that specifies the formatting and ticks details for axis in case it shows numeric values

Returns:

reference to this object

addDisplayedRangeChangeHandler

public LineChartNumericYAxis 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 LineChartNumericYAxis 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 LineChartNumericYAxis clearDisplayedRangeChangeHandler()

Description copied from interface: IGetDisplayedRangePropertyOwner

Clear all the displayed range changed actions.

Specified by:

clearDisplayedRangeChangeHandler in interface IGetDisplayedRangePropertyOwner

Returns:

reference to this object

setZeroInDisplayedRange

public LineChartNumericYAxis setZeroInDisplayedRange(boolean showZero)

Description copied from interface: IAutoAdjustmentPropertyOwner

Specifies an axis mode in which zero value is always exists in the displayed range. Redraws this chart if visibility is changed.

Specified by:

setZeroInDisplayedRange in interface IAutoAdjustmentPropertyOwner

Parameters:

showZero - flag setting zero value will be always in the displayed range

Returns:

reference to this object

See Also:

• Chart.redraw()

setDisplayedRangeMinValueAutoAdjustmentEnabled

public LineChartNumericYAxis setDisplayedRangeMinValueAutoAdjustmentEnabled(boolean enabled)

Description copied from interface: IAutoAdjustmentPropertyOwner

Specifies an axis mode in which the minimum axis value is equal to the minimum value of the currently displayed contents. Redraws this chart if value is changed.

Specified by:

setDisplayedRangeMinValueAutoAdjustmentEnabled in interface IAutoAdjustmentPropertyOwner

Parameters:

enabled - flag setting the minimum axis value will be equal to the minimum value of the currently displayed contents

Returns:

reference to this object

See Also:

• Chart.redraw()

setDisplayedRangeMaxValueAutoAdjustmentEnabled

public LineChartNumericYAxis setDisplayedRangeMaxValueAutoAdjustmentEnabled(boolean enabled)

Description copied from interface: IAutoAdjustmentPropertyOwner

Specifies an axis mode in which the maximum axis value is equal to the maximum value of the currently displayed contents. Redraws this chart if value is changed.

Specified by:

setDisplayedRangeMaxValueAutoAdjustmentEnabled in interface IAutoAdjustmentPropertyOwner

Parameters:

enabled - flag setting the maximum axis value will be equal to the maximum value of the currently displayed contents

Returns:

reference to this object

See Also:

• Chart.redraw()

isZeroInDisplayedRange

public boolean isZeroInDisplayedRange()

Description copied from interface: IAutoAdjustmentPropertyOwner

Checks whether zero is always exists in the displayed range.

Specified by:

isZeroInDisplayedRange in interface IAutoAdjustmentPropertyOwner

Returns:

true if zero is always exists in the displayed range, false otherwise

isDisplayedRangeMinValueAutoAdjustmentEnabled

public boolean isDisplayedRangeMinValueAutoAdjustmentEnabled()

Description copied from interface: IAutoAdjustmentPropertyOwner

Checks whether the minimum value is equal to the minimum value of the currently displayed contents.

Specified by:

isDisplayedRangeMinValueAutoAdjustmentEnabled in interface IAutoAdjustmentPropertyOwner

Returns:

true if the minimum value is equal to the minimum value of the currently displayed contents, false otherwise

isDisplayedRangeMaxValueAutoAdjustmentEnabled

public boolean isDisplayedRangeMaxValueAutoAdjustmentEnabled()

Description copied from interface: IAutoAdjustmentPropertyOwner

Checks whether the maximum value is equal to the maximum value of the currently displayed contents.

Specified by:

isDisplayedRangeMaxValueAutoAdjustmentEnabled in interface IAutoAdjustmentPropertyOwner

Returns:

true if the maximum value is equal to the maximum value of the currently displayed contents, false otherwise

setZeroGridLineVisible

public LineChartNumericYAxis setZeroGridLineVisible(boolean visible)

Description copied from interface: IZeroGridLinePropertyOwner

Specifies whether the zero grid line should be drawn. Redraws this chart if the visibility is changed.

Specified by:

setZeroGridLineVisible in interface IZeroGridLinePropertyOwner

Parameters:

visible - new zero grid line visibility

Returns:

reference to this object

See Also:

• Chart.redraw()

setZeroGridLineColor

public LineChartNumericYAxis setZeroGridLineColor(Color color)

Description copied from interface: IZeroGridLinePropertyOwner

Sets the new color to the zero grid line of this chart. Redraws this chart if color is changed.

Specified by:

setZeroGridLineColor in interface IZeroGridLinePropertyOwner

Parameters:

color - new zero grid line color

Returns:

reference to this object

See Also:

• Chart.redraw()

setZeroGridLineColor

public LineChartNumericYAxis setZeroGridLineColor(javafx.scene.paint.Color color)

Description copied from interface: IZeroGridLinePropertyOwner

Sets the new color to the zero grid line of this chart. Redraws this chart if color is changed.

Specified by:

setZeroGridLineColor in interface IZeroGridLinePropertyOwner

Parameters:

color - new zero grid line color

Returns:

reference to this object

See Also:

• Chart.redraw()

setZeroGridLineWidth

public LineChartNumericYAxis setZeroGridLineWidth(int width)

Description copied from interface: IZeroGridLinePropertyOwner

Sets the new width to the zero grid line of this chart, in pixels. Redraws this chart if width is changed.

Specified by:

setZeroGridLineWidth in interface IZeroGridLinePropertyOwner

Parameters:

width - new zero grid line width, in pixels

Returns:

reference to this object

See Also:

• Chart.redraw()

isZeroGridLineVisible

public boolean isZeroGridLineVisible()

Description copied from interface: IZeroGridLinePropertyOwner

Checks whether the zero grid line is visible.

Specified by:

isZeroGridLineVisible in interface IZeroGridLinePropertyOwner

Returns:

true if zero grid line is visible, false otherwise

getZeroGridLineColor

public javafx.scene.paint.Color getZeroGridLineColor()

Description copied from interface: IZeroGridLinePropertyOwner

Returns the color of the zero grid line.

Specified by:

getZeroGridLineColor in interface IZeroGridLinePropertyOwner

Returns:

the color of the zero grid line

getZeroGridLineWidth

public int getZeroGridLineWidth()

Description copied from interface: IZeroGridLinePropertyOwner

Returns the width of the zero grid line, in pixels.

Specified by:

getZeroGridLineWidth in interface IZeroGridLinePropertyOwner

Returns:

the width of the zero grid line, in pixels

setLabelsFormat

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

Description copied from interface: INumericStylePropertyOwner

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.

Specified by:

setLabelsFormat in interface INumericStylePropertyOwner

Parameters:

format - new axis labels formatter

Returns:

reference to this object

setTitle

public LineChartNumericYAxis setTitle(String title)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new title to this axis. Redraws this axis and it's parent chart if title is changed.

Specified by:

setTitle in interface IAxisTitlePropertyOwner<Number>

Parameters:

title - new axis title

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleVisible

public LineChartNumericYAxis setTitleVisible(boolean visible)

Description copied from interface: IAxisTitlePropertyOwner

Specifies whether this axis title should be drawn. Redraws this axis and it's parent chart if visibility is changed.

Specified by:

setTitleVisible in interface IAxisTitlePropertyOwner<Number>

Parameters:

visible - new axis title visibility

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFont

public LineChartNumericYAxis setTitleFont(javafx.scene.text.Font font)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font to this axis title. Redraws this axis and it's parent chart if font is changed.

Specified by:

setTitleFont in interface IAxisTitlePropertyOwner<Number>

Parameters:

font - new axis title font

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleFontSize

public LineChartNumericYAxis setTitleFontSize(int fontSize)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new font size to this axis title. Redraws this axis and it's parent chart if font size is changed.

Specified by:

setTitleFontSize in interface IAxisTitlePropertyOwner<Number>

Parameters:

fontSize - new axis title font size

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public LineChartNumericYAxis setTitleColor(Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<Number>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

setTitleColor

public LineChartNumericYAxis setTitleColor(javafx.scene.paint.Color color)

Description copied from interface: IAxisTitlePropertyOwner

Sets the new color to this axis title. Redraws this axis and it's parent chart if color is changed.

Specified by:

setTitleColor in interface IAxisTitlePropertyOwner<Number>

Parameters:

color - new axis title color

Returns:

reference to this object

See Also:

• Chart.redraw()

getTitleColor

public javafx.scene.paint.Color getTitleColor()

Description copied from interface: IAxisTitlePropertyOwner

Returns the color of this axis title.

Specified by:

getTitleColor in interface IAxisTitlePropertyOwner<Number>

Returns:

the color of this axis title

getTitle

public String getTitle()

Description copied from interface: IAxisTitlePropertyOwner

Returns the title of this axis, or null if title has not been specified.

Specified by:

getTitle in interface IAxisTitlePropertyOwner<Number>

Returns:

the title of this axis, or null if title has not been specified

isTitleVisible

public boolean isTitleVisible()

Description copied from interface: IAxisTitlePropertyOwner

Checks whether this axis title should be drawn.

Specified by:

isTitleVisible in interface IAxisTitlePropertyOwner<Number>

Returns:

true if this axis title should be drawn, false otherwise

getTitleFont

public javafx.scene.text.Font getTitleFont()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font of this axis title.

Specified by:

getTitleFont in interface IAxisTitlePropertyOwner<Number>

Returns:

axis title font

getTitleFontSize

public int getTitleFontSize()

Description copied from interface: IAxisTitlePropertyOwner

Returns the font size of this axis title.

Specified by:

getTitleFontSize in interface IAxisTitlePropertyOwner<Number>

Returns:

the font size of this axis title