Package com.amalgamasimulation.charts

Class AbstractLineChart

java.lang.Object

com.amalgamasimulation.charts.Chart<ILineChartVisualSet,LineVisualSetContainer>

com.amalgamasimulation.charts.AbstractLineChart

All Implemented Interfaces:

IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Direct Known Subclasses:

NumericLineChart, TimeLineChart

public abstract class AbstractLineChart
extends Chart<ILineChartVisualSet,LineVisualSetContainer>
implements IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Used to show linear plots or clouds of points in two-dimensional coordinates.

Author:

Aleksey Kirillov

Field Summary

Fields

Modifier and Type	Field	Description
protected com.amalgamasimulation.charts.internals.charts.LineChartInternal	internalLineChart

Constructor Summary

Constructors

Constructor	Description
AbstractLineChart()

Method Summary

Modifier and Type	Method	Description
AbstractLineChart	addContextMenuItem(LineChartContextMenuItem contextMenuItem)	Adds the new context menu item to the end of the items list.
void	addVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)	Adds the action to be executed every time the vertical guideline visibility or position is changed.
AbstractLineChart	clearContextMenuItems()	Removes all context menu items added by the 'addContextMenuItem' calls.
void	clearVerticalGuidelineChangeHandlers()	Clear all the vertical guideline visibility or position changed actions.
final com.amalgamasimulation.charts.internals.charts.LineChartInternal	getChartInternal()
abstract Legend<ILineChartVisualSet,com.amalgamasimulation.charts.internals.charts.LineChartInternal>	getLegend()	Returns the Legend currently shown on this chart.
javafx.scene.paint.Color	getVerticalGuidelineColor()	Returns the current color of the vertical guideline.
Function<Double,String>	getVerticalGuidelineLabelFormat()	Return the formatter of the vertical guideline label.
double	getVerticalGuidelinePosition()	Returns the current X-axis position of vertical guideline.
double	getVerticalGuidelineWidth()	Returns the current width of the vertical guideline.
AbstractLineChart	hideVerticalGuideline()	Hides the currently displayed vertical guideline.
boolean	isVerticalGuidelineDisplayed()	Checks whether vertical guideline is displayed.
boolean	isVerticalGuidelineLabelVisible()	Checks whether the vertical guideline label is drawn.
boolean	isVerticalGuidelineSnapToGridLines()	Checks whether vertical guideline is snapped to grid lines.
boolean	isVerticalGuidelineValuesVisible()	Checks whether the legend values are drawn.
boolean	isVerticalGuidelineVisible()	Checks whether vertical guideline is drawn.
AbstractLineChart	removeContextMenuItem(LineChartContextMenuItem contextMenuHandler)	Removes the context menu item.
void	removeVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)	Removes the vertical guideline visibility or position changed action.
AbstractLineChart	setVerticalGuidelineColor(Color color)	Sets the new color to the vertical guideline.
AbstractLineChart	setVerticalGuidelineColor(javafx.scene.paint.Color color)	Sets the new color to the vertical guideline.
AbstractLineChart	setVerticalGuidelineLabelFormat(Function<Double,String> format)	Sets the formatter to vertical guideline label, i.e.
AbstractLineChart	setVerticalGuidelineLabelVisible(boolean visible)	Specifies whether the vertical guideline label should be drawn.
AbstractLineChart	setVerticalGuidelineSnapToGridLines(boolean snapToGridLines)	Specifies whether the vertical guideline should be snapped to grid lines.
AbstractLineChart	setVerticalGuidelineValuesVisible(boolean visible)	Specifies whether the legend values of the applicable visual sets should be drawn when a vertical guideline is shown.
AbstractLineChart	setVerticalGuidelineVisible(boolean visible)	Specifies whether the vertical guideline functionality should be enabled for the end users of this chart.
AbstractLineChart	setVerticalGuidelineWidth(double width)	Sets the new width to the vertical guideline, in pixels.
AbstractLineChart	showVerticalGuidelineDisplayed(double position)	Shows a vertical guideline at the specified X-axis position.

Methods inherited from class com.amalgamasimulation.charts.Chart

addKeyPressedHandler, addKeyReleasedHandler, addMouseDragExitedHandler, addMouseDraggedHandler, addMouseDragOverHandler, addMouseDragReleasedHandler, addMouseEnteredHandlers, addMouseExitedHandler, addMousePressedHandler, addMouseReleasedHandler, addMouseScrollHandler, addRedrawFinishedHandler, addTextLabel, addTextLabel, clearKeyPressedHandlers, clearKeyReleasedHandlers, clearMouseDragExitedHandlers, clearMouseDraggedHandlers, clearMouseDragOverHandlers, clearMouseDragReleasedHandlers, clearMouseEnteredHandlers, clearMouseExitedHandlers, clearMousePressedHandlers, clearMouseReleasedHandlers, clearMouseScrollHandlers, clearRedrawFinishedHandlers, copyToClipboard, dispose, getBackgroundColor, getBottomMargin, getContentBackgroundColor, getGridLinesColor, getGridLinesWidth, getLeftMargin, getTitle, getTitleColor, getTitleFont, getTitleFontSize, getTopMargin, getVisualSetContainer, getXAxis, getYAxis, getZeroGridLineColor, getZeroGridLineWidth, initializeChartGroup, isDisposed, isGridLinesVisible, isRedrawInProgress, isShown, isTitleVisible, isVisible, isVisualSetVisible, isZeroGridLineVisible, redraw, removeKeyPressedHandler, removeKeyReleasedHandler, removeMouseDragExitedHandler, removeMouseDraggedHandler, removeMouseDragOverHandler, removeMouseDragReleasedHandler, removeMouseEnteredHandler, removeMouseExitedHandler, removeMousePressedHandler, removeMouseReleasedHandler, removeMouseScrollHandler, removeRedrawFinishedHandler, removeTextLabel, resizeChart, setBackgroundColor, setBackgroundColor, setBottomMargin, setContentBackgroundColor, setContentBackgroundColor, setContextMenuVisible, setCopyToClipboardContextMenuItemVisible, setGridLinesColor, setGridLinesColor, setGridLinesVisible, setGridLinesWidth, setLeftMargin, setTitle, setTitleColor, setTitleColor, setTitleFont, setTitleFontSize, setTitleVisible, setTopMargin, setVisibility, setVisualSetContainer, setVisualSetVisible, setZeroGridLineColor, setZeroGridLineColor, setZeroGridLineVisible, setZeroGridLineWidth, updateSize

Methods inherited from class java.lang.Object

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

Field Details

internalLineChart

protected com.amalgamasimulation.charts.internals.charts.LineChartInternal internalLineChart

Constructor Details

AbstractLineChart

public AbstractLineChart()

Method Details

getChartInternal

public final com.amalgamasimulation.charts.internals.charts.LineChartInternal getChartInternal()

Specified by:

getChartInternal in class Chart<ILineChartVisualSet,LineVisualSetContainer>

getLegend

public abstract Legend<ILineChartVisualSet,com.amalgamasimulation.charts.internals.charts.LineChartInternal> getLegend()

Returns the Legend currently shown on this chart.

Returns:

the Legend currently shown on this chart

setVerticalGuidelineLabelFormat

public AbstractLineChart setVerticalGuidelineLabelFormat(Function<Double,String> format)

Sets the formatter to vertical guideline label, i.e. the function that takes a Double value and produces a String that should be drawn to represent this value. Redraws this chart

Parameters:

format - new vertical guideline label formatter

Returns:

reference to this object

See Also:

• Chart.redraw()

getVerticalGuidelineLabelFormat

public Function<Double,String> getVerticalGuidelineLabelFormat()

Return the formatter of the vertical guideline label.

Returns:

the formatter of the vertical guideline label

addContextMenuItem

public AbstractLineChart addContextMenuItem(LineChartContextMenuItem contextMenuItem)

Adds the new context menu item to the end of the items list.

Parameters:

contextMenuItem - new context menu item

Returns:

reference to this object

removeContextMenuItem

public AbstractLineChart removeContextMenuItem(LineChartContextMenuItem contextMenuHandler)

Removes the context menu item.

Parameters:

contextMenuHandler - removed context menu item

Returns:

reference to this object

clearContextMenuItems

public AbstractLineChart clearContextMenuItems()

Removes all context menu items added by the 'addContextMenuItem' calls. Does not affect pre-installed items such as 'copy to clipboard'.

Returns:

reference to this object

setVerticalGuidelineVisible

public AbstractLineChart setVerticalGuidelineVisible(boolean visible)

Description copied from interface: IVerticalGuidelineOwner

Specifies whether the vertical guideline functionality should be enabled for the end users of this chart. This functionality allows the users to show and hide the vertical guideline by clicking on the chart contents area. Redraws this chart if visibility is changed.

Vertical guideline functionality is enabled by default.

Specified by:

setVerticalGuidelineVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

visible - true if vertical guideline functionality should be enabled, false otherwise

Returns:

reference to this object

setVerticalGuidelineLabelVisible

public AbstractLineChart setVerticalGuidelineLabelVisible(boolean visible)

Description copied from interface: IVerticalGuidelineOwner

Specifies whether the vertical guideline label should be drawn. Is true by default. Redraws this chart if visibility is changed.

Specified by:

setVerticalGuidelineLabelVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

visible - new vertical guideline label visibility

Returns:

reference to this object

setVerticalGuidelineValuesVisible

public AbstractLineChart setVerticalGuidelineValuesVisible(boolean visible)

Description copied from interface: IVerticalGuidelineOwner

Specifies whether the legend values of the applicable visual sets should be drawn when a vertical guideline is shown. The displayed values are the result of the intersection of the corresponding data elements with a vertical guideline. Is true by default. Redraws this chart if visibility is changed.

Specified by:

setVerticalGuidelineValuesVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

visible - true if the legend values should be drawn, false otherwise

Returns:

reference to this object

showVerticalGuidelineDisplayed

public AbstractLineChart showVerticalGuidelineDisplayed(double position)

Description copied from interface: IVerticalGuidelineOwner

Shows a vertical guideline at the specified X-axis position. Redraws this chart.

Specified by:

showVerticalGuidelineDisplayed in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

position - specified X-axis position of the vertical guideline

Returns:

reference to this object

setVerticalGuidelineColor

public AbstractLineChart setVerticalGuidelineColor(Color color)

Description copied from interface: IVerticalGuidelineOwner

Sets the new color to the vertical guideline. Redraws this chart if color is changed.

Specified by:

setVerticalGuidelineColor in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

color - new vertical guideline color

Returns:

reference to this object

setVerticalGuidelineColor

public AbstractLineChart setVerticalGuidelineColor(javafx.scene.paint.Color color)

Description copied from interface: IVerticalGuidelineOwner

Sets the new color to the vertical guideline. Redraws this chart if color is changed.

Specified by:

setVerticalGuidelineColor in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

color - new vertical guideline color

Returns:

reference to this object

setVerticalGuidelineWidth

public AbstractLineChart setVerticalGuidelineWidth(double width)

Description copied from interface: IVerticalGuidelineOwner

Sets the new width to the vertical guideline, in pixels. Redraws this chart if width is changed.

Specified by:

setVerticalGuidelineWidth in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

width - new vertical guideline width, in pixels

Returns:

reference to this object

isVerticalGuidelineVisible

public boolean isVerticalGuidelineVisible()

Description copied from interface: IVerticalGuidelineOwner

Checks whether vertical guideline is drawn.

Specified by:

isVerticalGuidelineVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

true if vertical guideline is drawn, false otherwise

isVerticalGuidelineLabelVisible

public boolean isVerticalGuidelineLabelVisible()

Description copied from interface: IVerticalGuidelineOwner

Checks whether the vertical guideline label is drawn.

Specified by:

isVerticalGuidelineLabelVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

true if the vertical guideline label is drawn, false otherwise

isVerticalGuidelineValuesVisible

public boolean isVerticalGuidelineValuesVisible()

Description copied from interface: IVerticalGuidelineOwner

Checks whether the legend values are drawn.

Specified by:

isVerticalGuidelineValuesVisible in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

true if the legend values are drawn, false otherwise

getVerticalGuidelineColor

public javafx.scene.paint.Color getVerticalGuidelineColor()

Description copied from interface: IVerticalGuidelineOwner

Returns the current color of the vertical guideline.

Specified by:

getVerticalGuidelineColor in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

the current color of the vertical guideline

getVerticalGuidelineWidth

public double getVerticalGuidelineWidth()

Description copied from interface: IVerticalGuidelineOwner

Returns the current width of the vertical guideline.

Specified by:

getVerticalGuidelineWidth in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

the current width of the vertical guideline

hideVerticalGuideline

public AbstractLineChart hideVerticalGuideline()

Description copied from interface: IVerticalGuidelineOwner

Hides the currently displayed vertical guideline. Redraws this chart. Does nothing if the vertical guideline is not currently displayed.

Specified by:

hideVerticalGuideline in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

reference to this object

isVerticalGuidelineDisplayed

public boolean isVerticalGuidelineDisplayed()

Description copied from interface: IVerticalGuidelineOwner

Checks whether vertical guideline is displayed.

Specified by:

isVerticalGuidelineDisplayed in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

true if vertical guideline is displayed

getVerticalGuidelinePosition

public double getVerticalGuidelinePosition()

Description copied from interface: IVerticalGuidelineOwner

Returns the current X-axis position of vertical guideline.

Specified by:

getVerticalGuidelinePosition in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

the current X-axis position of vertical guideline

setVerticalGuidelineSnapToGridLines

public AbstractLineChart setVerticalGuidelineSnapToGridLines(boolean snapToGridLines)

Description copied from interface: IVerticalGuidelineOwner

Specifies whether the vertical guideline should be snapped to grid lines.

Specified by:

setVerticalGuidelineSnapToGridLines in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

snapToGridLines - new value of property vertical guideline snapped to grid lines

Returns:

reference to this object

isVerticalGuidelineSnapToGridLines

public boolean isVerticalGuidelineSnapToGridLines()

Description copied from interface: IVerticalGuidelineOwner

Checks whether vertical guideline is snapped to grid lines.

Specified by:

isVerticalGuidelineSnapToGridLines in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Returns:

true if vertical guideline is snapped to grid lines

addVerticalGuidelineChangeHandler

public void addVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)

Description copied from interface: IVerticalGuidelineOwner

Adds the action to be executed every time the vertical guideline visibility or position is changed.

Specified by:

addVerticalGuidelineChangeHandler in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

handler - new action to be executed every time the vertical guideline visibility or position is changed

removeVerticalGuidelineChangeHandler

public void removeVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)

Description copied from interface: IVerticalGuidelineOwner

Removes the vertical guideline visibility or position changed action.

Specified by:

removeVerticalGuidelineChangeHandler in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>

Parameters:

handler - removed vertical guideline visibility or position changed action

clearVerticalGuidelineChangeHandlers

public void clearVerticalGuidelineChangeHandlers()

Description copied from interface: IVerticalGuidelineOwner

Clear all the vertical guideline visibility or position changed actions.

Specified by:

clearVerticalGuidelineChangeHandlers in interface IVerticalGuidelineOwner<ILineChartVisualSet,LineVisualSetContainer>