Package com.amalgamasimulation.charts.visualsets

Class LineVisualSet<T>

java.lang.Object

com.amalgamasimulation.charts.visualsets.VisualSet<T>

com.amalgamasimulation.charts.visualsets.AbstractLineVisualSet<T>

com.amalgamasimulation.charts.visualsets.LineVisualSet<T>

Type Parameters:

T - visual set data elements type

All Implemented Interfaces:

IClipboardTextPropertyOwner<Double>, ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, ILineChartVisualSet

public class LineVisualSet<T>
extends AbstractLineVisualSet<T>
implements ILineChartVisualSet, IClipboardTextPropertyOwner<Double>

Visual set for drawing line plots with points. Optionally draws the plot as a stack diagram.

Can be drawn on AbstractLineChart.

Does not allow multiple data elements with the same X-axis value. All elements must be ordered in ascending order of values along the x-axis.

Author:

Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LineVisualSet.InterpolationType	Enumeration that represents the interpolation type of a plot.
static enum	LineVisualSet.LineDrawingPolicy	Enumeration that represents the way to draw the elements of the plot.
class	LineVisualSet.LineVisualElement	Internal class that represents visual element for line data element.

Nested classes/interfaces inherited from class com.amalgamasimulation.charts.visualsets.AbstractLineVisualSet

AbstractLineVisualSet.AbstractLineVisualElement, AbstractLineVisualSet.Extrapolation, AbstractLineVisualSet.PointsAndLinesStyle

Nested classes/interfaces inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

VisualSet.ContextMenuHandler<T>, VisualSet.UpdatePolicy, VisualSet.VisualElement

Field Summary

Fields

Modifier and Type	Field	Description
protected Function<Double,String>	clipboardTextExtractor
protected LineVisualSet.InterpolationType	interpolationType
protected LineVisualSet.LineDrawingPolicy	lineDrawingPolicy
protected Color	stackFillColor
protected boolean	stackVisible

Fields inherited from class com.amalgamasimulation.charts.visualsets.AbstractLineVisualSet

extrapolation, legendTextProvider, lineColor, lineStyle, lineWidth, maxValueProvider, pointsAndLinesStyle, pointSize, valueExtractor

Fields inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

argumentExtractor, contentsToBeginArguments, contentsToEndArguments, contentsToVisualElements, contextMenuHandlers, dataElementsProvider, listeners, maxArgument, maxValueCache, minArgument, minValueCache, mouseEnterHandlers, mouseExitHandlers, mousePressedHandlers, mouseTransparent, name, needsUpdate, oldContentsList, tooltipTextExtractor, updatePolicy, visibilityChangeHandlers, visualElementsList

Constructor Summary

Constructors

Constructor	Description
LineVisualSet(String name, Supplier<List<T>> dataElementsProvider, Function<T,Double> argumentExtractor, Function<T,Double> valueExtractor)	Constructs a LineVisualSet with given name, data elements and arguments/value extractors, i.e.

Method Summary

Modifier and Type	Method	Description
LineVisualSet<T>	addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
LineVisualSet<T>	addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
LineVisualSet<T>	addMouseExitHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time the mouse exits the previously entered element's bounds.
LineVisualSet<T>	addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
LineVisualSet<T>	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
LineVisualSet<T>.LineVisualElement	createVisualElement(T contents)	Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.
String	getClipboardText(Double object)	Returns the text that will be copied to clipboard for the given object.
List<T>	getContents()	Returns the list of visual set contents.
LineVisualSet.InterpolationType	getInterpolationType()	Returns the current LineVisualSet.InterpolationType i.e.
Color	getLegendColor()	Returns the color of the Legend's icon corresponding to this VisualSet
LineVisualSet.LineDrawingPolicy	getLineDrawingPolicy()	Returns the current LineVisualSet.LineDrawingPolicy i.e.
Color	getStackFillColor()	Returns the color of a stack visual element.
List<LineVisualSet<T>.LineVisualElement>	getVisualElements(boolean recalculationRequired)	Returns the list of visual elements corresponding to current data elements.
boolean	isStackVisible()	Returns the visibility of a stack visual element.
LineVisualSet<T>	setClipboardText(Function<Double,String> clipboardTextExtractor)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
LineVisualSet<T>	setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)	Sets the of the plot i.e.
LineVisualSet<T>	setInterpolationType(LineVisualSet.InterpolationType interpolationType)	Sets the new LineVisualSet.InterpolationType i.e.
LineVisualSet<T>	setLegendText(Supplier<String> legendTextProvider)	Sets the Legend label text represents this visual set.
LineVisualSet<T>	setLineColor(Color color)	Sets the line color of the plot.
LineVisualSet<T>	setLineDrawingPolicy(LineVisualSet.LineDrawingPolicy lineDrawingPolicy)	Sets the new LineVisualSet.LineDrawingPolicy i.e.
LineVisualSet<T>	setLineStyle(LineStyle lineStyle)	Sets the LineStyle of the plot i.e.
LineVisualSet<T>	setLineWidth(double width)	Sets the width of the line, in pixels.
LineVisualSet<T>	setMaxValue(Supplier<Double> maxValueProvider)	Sets the supplier of max value.
LineVisualSet<T>	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
LineVisualSet<T>	setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)	Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e.
LineVisualSet<T>	setPointSize(double pointSize)	Sets the diameter of the point, in pixels.
LineVisualSet<T>	setStackFillColor(Color stackFillColor)	Sets the color of a stack visual element.
LineVisualSet<T>	setStackVisible(boolean stackVisible)	Sets the visibility of a stack visual element.
LineVisualSet<T>	setTooltipText(Function<T,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
LineVisualSet<T>	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.

Methods inherited from class com.amalgamasimulation.charts.visualsets.AbstractLineVisualSet

getExtrapolation, getLegendText, getLineColor, getLineStyle, getLineWidth, getMaxValue, getMinValue, getPointsAndLinesStyle, getPointSize, getValue

Methods inherited from class com.amalgamasimulation.charts.visualsets.VisualSet

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContextMenuHandlers, getDataElements, getInjectionIndex, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, sortVisualElements, toString, update, updateMinMaxArgumentsValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.charts.visualsets.types.IAbstractChartVisualSet

addVisualSetChangeHandler, getMaxArgument, getMinArgument, getName, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementsCount, isMouseTransparent, removeVisibilityChangeHandler, removeVisualSetChangeHandler

Methods inherited from interface com.amalgamasimulation.charts.visualsets.IUpdatePolicyPropertyOwner

getUpdatePolicy

Field Details

interpolationType

protected LineVisualSet.InterpolationType interpolationType

lineDrawingPolicy

protected LineVisualSet.LineDrawingPolicy lineDrawingPolicy

stackVisible

protected boolean stackVisible

stackFillColor

protected Color stackFillColor

clipboardTextExtractor

protected Function<Double,String> clipboardTextExtractor

Constructor Details

LineVisualSet

public LineVisualSet(String name,
 Supplier<List<T>> dataElementsProvider,
 Function<T,Double> argumentExtractor,
 Function<T,Double> valueExtractor)

Constructs a LineVisualSet with given name, data elements and arguments/value extractors, i.e. a functions that specifies the rule for extracting an argument/value from a data element.

Parameters:

name - visual set name is used to sort and name the visual sets on the chart

dataElementsProvider - data elements list provider. The provider is invalidated every time the chart is being redrawn

argumentExtractor - a function that specifies the rule for extracting an argument from a data element

valueExtractor - a function that specifies the rule for extracting a value from a data element

Method Details

setLineDrawingPolicy

public LineVisualSet<T> setLineDrawingPolicy(LineVisualSet.LineDrawingPolicy lineDrawingPolicy)

Sets the new LineVisualSet.LineDrawingPolicy i.e. the way to draw the elements of the plot.

Parameters:

lineDrawingPolicy - new LineVisualSet.LineDrawingPolicy i.e. the way to draw the elements of the plot

Returns:

reference to this object

setInterpolationType

public LineVisualSet<T> setInterpolationType(LineVisualSet.InterpolationType interpolationType)

Sets the new LineVisualSet.InterpolationType i.e. the interpolation type of the data for a given plot.

Parameters:

interpolationType - new LineVisualSet.InterpolationType i.e. the interpolation type of the data for a given plot

Returns:

reference to this object

setStackVisible

public LineVisualSet<T> setStackVisible(boolean stackVisible)

Sets the visibility of a stack visual element. The stack is an element that fills the space between the plot and the zero Y-axis grid line.

Parameters:

stackVisible - new visibility of a stack visual element

Returns:

reference to this object

setStackFillColor

public LineVisualSet<T> setStackFillColor(Color stackFillColor)

Sets the color of a stack visual element. The stack is an element that fills the space between the plot and the zero Y-axis grid line.

Parameters:

stackFillColor - new color of a stack visual element

Returns:

reference to this object

setExtrapolation

public LineVisualSet<T> setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)

Description copied from class: AbstractLineVisualSet

Sets the of the plot i.e. mode of extending a line to the maximum argument among all visual sets or to the current argument along the horizontal axis. Applicable only for AbstractLineVisualSet.

Overrides:

setExtrapolation in class AbstractLineVisualSet<T>

Parameters:

extrapolation - the AbstractLineVisualSet.Extrapolation of the plot

Returns:

reference to this object

getLineDrawingPolicy

public LineVisualSet.LineDrawingPolicy getLineDrawingPolicy()

Returns the current LineVisualSet.LineDrawingPolicy i.e. the way to draw the elements of the plot.

Returns:

the current LineVisualSet.LineDrawingPolicy i.e. the way to draw the elements of the plot

getInterpolationType

public LineVisualSet.InterpolationType getInterpolationType()

Returns the current LineVisualSet.InterpolationType i.e. the interpolation type of the data for a given plot.

Returns:

the current LineVisualSet.InterpolationType i.e. the interpolation type of the data for a given plot

isStackVisible

public boolean isStackVisible()

Returns the visibility of a stack visual element.

Returns:

the visibility of a stack visual element

getStackFillColor

public Color getStackFillColor()

Returns the color of a stack visual element.

Returns:

the color of a stack visual element

setClipboardText

public LineVisualSet<T> setClipboardText(Function<Double,String> clipboardTextExtractor)

Description copied from interface: IClipboardTextPropertyOwner

Sets the conversion method from values of each plot data element into text that will be copied to clipboard.

Specified by:

setClipboardText in interface IClipboardTextPropertyOwner<T>

Parameters:

clipboardTextExtractor - an extractor that converts the value of each plot data element into text that will be copied to the clipboard

Returns:

reference to this object

setLineColor

public LineVisualSet<T> setLineColor(Color color)

Description copied from class: AbstractLineVisualSet

Sets the line color of the plot. Transparent and semi-transparent colors are allowed.

Overrides:

setLineColor in class AbstractLineVisualSet<T>

Parameters:

color - the line color of the plot

Returns:

reference to this object

setTooltipText

public LineVisualSet<T> setTooltipText(Function<T,String> tooltipTextExtractor)

Description copied from class: VisualSet

Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.

Specified by:

setTooltipText in class VisualSet<T>

Parameters:

tooltipTextExtractor - a function that specifies the rule for extracting a tooltip text from a data element

Returns:

reference to this object

setLineWidth

public LineVisualSet<T> setLineWidth(double width)

Description copied from class: AbstractLineVisualSet

Sets the width of the line, in pixels.

Overrides:

setLineWidth in class AbstractLineVisualSet<T>

Parameters:

width - the width of the line, in pixels

Returns:

reference to this object

setPointSize

public LineVisualSet<T> setPointSize(double pointSize)

Description copied from class: AbstractLineVisualSet

Sets the diameter of the point, in pixels.

Overrides:

setPointSize in class AbstractLineVisualSet<T>

Parameters:

pointSize - the diameter of the point, in pixels

Returns:

reference to this object

setLegendText

public LineVisualSet<T> setLegendText(Supplier<String> legendTextProvider)

Description copied from interface: ILegendNodePropertiesOwner

Sets the Legend label text represents this visual set.

Specified by:

setLegendText in interface ILegendNodePropertiesOwner

Overrides:

setLegendText in class AbstractLineVisualSet<T>

Parameters:

legendTextProvider - the Legend label text represents this visual set

Returns:

reference to this object

setPointsAndLinesStyle

public LineVisualSet<T> setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)

Description copied from class: AbstractLineVisualSet

Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements.

Overrides:

setPointsAndLinesStyle in class AbstractLineVisualSet<T>

Parameters:

pointsAndLinesStyle - the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e. the methodology of drawing the visual elements for data elements

Returns:

reference to this object

getClipboardText

public String getClipboardText(Double object)

Description copied from interface: IClipboardTextPropertyOwner

Returns the text that will be copied to clipboard for the given object.

Specified by:

getClipboardText in interface IClipboardTextPropertyOwner<T>

Parameters:

object - object for which the clipboard text is being checked

Returns:

the text that will be copied to clipboard for the given object

getContents

public List<T> getContents()

Description copied from interface: IAbstractChartVisualSet

Returns the list of visual set contents.

Specified by:

getContents in interface IAbstractChartVisualSet

Overrides:

getContents in class VisualSet<T>

Returns:

the list of visual set contents

addContextMenuHandler

public LineVisualSet<T> addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)

Description copied from class: VisualSet

Adds the action to be executed every time a context menu for given data element is called.

Overrides:

addContextMenuHandler in class VisualSet<T>

Parameters:

contextMenuHandler - context menu call action

Returns:

reference to this object

addMouseEnterHandler

public LineVisualSet<T> addMouseEnterHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time mouse enters to any visual element borders.

Overrides:

addMouseEnterHandler in class VisualSet<T>

Parameters:

handler - new mouse enter action

Returns:

reference to this object

addMouseExitHandler

public LineVisualSet<T> addMouseExitHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time the mouse exits the previously entered element's bounds.

Overrides:

addMouseExitHandler in class VisualSet<T>

Parameters:

handler - new mouse exit action

Returns:

reference to this object

addMousePressedHandler

public LineVisualSet<T> addMousePressedHandler(BiConsumer<T,javafx.scene.input.MouseEvent> handler)

Description copied from class: VisualSet

Adds the action to be executed every time a mouse button is pressed.

Overrides:

addMousePressedHandler in class VisualSet<T>

Parameters:

handler - new mouse button pressed action

Returns:

reference to this object

addVisibilityChangeHandler

public LineVisualSet<T> addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)

Description copied from interface: IAbstractChartVisualSet

Adds the action to be executed every time the visibility of this VisualSet is changed.

Specified by:

addVisibilityChangeHandler in interface IAbstractChartVisualSet

Overrides:

addVisibilityChangeHandler in class VisualSet<T>

Parameters:

visibilityChangeHandler - visibility change action

Returns:

reference to this object

setMouseTransparent

public LineVisualSet<T> setMouseTransparent(boolean mouseTransparent)

Description copied from interface: IAbstractChartVisualSet

Sets the value of the property mouseTransparent. If true, this VisualSet is completely transparent to mouse events. When choosing target for mouse event, VisualSets with mouseTransparent set to true won't be taken into account.

Specified by:

setMouseTransparent in interface IAbstractChartVisualSet

Overrides:

setMouseTransparent in class VisualSet<T>

Parameters:

mouseTransparent - new value of property mouseTransparent

Returns:

reference to this object

getVisualElements

public List<LineVisualSet<T>.LineVisualElement> getVisualElements(boolean recalculationRequired)

Description copied from interface: IAbstractChartVisualSet

Returns the list of visual elements corresponding to current data elements. Cannot be changed by the user.

Specified by:

getVisualElements in interface IAbstractChartVisualSet

Specified by:

getVisualElements in interface ILineChartVisualSet

Overrides:

getVisualElements in class VisualSet<T>

Parameters:

recalculationRequired - flag of the need to recalculate the visual elements

Returns:

the list of visual elements corresponding to current data elements

createVisualElement

public LineVisualSet<T>.LineVisualElement createVisualElement(T contents)

Description copied from class: VisualSet

Creates a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type.

Specified by:

createVisualElement in class VisualSet<T>

Parameters:

contents - data element for which the VisualSet<T>.VisualElement is being checked

Returns:

a new instance of VisualSet<T>.VisualElement corresponding to the current VisualSet type

getLegendColor

public Color getLegendColor()

Description copied from interface: ILegendNodePropertiesOwner

Returns the color of the Legend's icon corresponding to this VisualSet

Specified by:

getLegendColor in interface ILegendNodePropertiesOwner

Overrides:

getLegendColor in class AbstractLineVisualSet<T>

Returns:

the color of the Legend's icon corresponding to this VisualSet

setUpdatePolicy

public LineVisualSet<T> setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)

Description copied from interface: IAbstractChartVisualSet

Sets the new VisualSet.UpdatePolicy i.e. the VisualSet update control rule.

Specified by:

setUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

setUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

setUpdatePolicy in class VisualSet<T>

Parameters:

updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule

Returns:

reference to this object

setLineStyle

public LineVisualSet<T> setLineStyle(LineStyle lineStyle)

Description copied from class: AbstractLineVisualSet

Sets the LineStyle of the plot i.e. the methodology of drawing the lines for data elements.

Overrides:

setLineStyle in class AbstractLineVisualSet<T>

Parameters:

lineStyle - the LineStyle of the plot i.e. the methodology of drawing the lines for data elements

Returns:

reference to this object

setMaxValue

public LineVisualSet<T> setMaxValue(Supplier<Double> maxValueProvider)

Description copied from class: AbstractLineVisualSet

Sets the supplier of max value. This value allows to set some "natural" max value of the data being displayed It will be used when scaling the Y-axis of the chart.

Overrides:

setMaxValue in class AbstractLineVisualSet<T>

Parameters:

maxValueProvider - the supplier of max value

Returns:

reference to this object