Package com.amalgamasimulation.visualsets

Class PiecewiseLineVisualSet

java.lang.Object

com.amalgamasimulation.visualsets.VisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.AbstractLineVisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.LineVisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.PiecewiseLineVisualSet

All Implemented Interfaces:

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

public class PiecewiseLineVisualSet
extends LineVisualSet<Pair<Double,Double>>
implements IPiecewiseVisualSet

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

Uses a discretization method to reduce the amount of data displayed on the chart to improve drawing performance. The discretization settings are the same as in PiecewisePolylineVisualSet.

The current arguments range displayed on the chart is always used to determine the sampling factor.

The PiecewiseFunction.InterpolationType defines the values of the discretized points, the LineVisualSet.InterpolationType defines the way the points are connected:

• LineVisualSet.InterpolationType.LINEAR the points are connected with straight lines. Step changes of the PiecewiseFunction are drawn as (visually) vertical lines.
• LineVisualSet.InterpolationType.STEP the value of each point is held until the next point, the value after a step change is used. If the function was discretized with PiecewiseFunction.InterpolationType.PEAK, each discretization step holds the peak value found within this step.

Only UpdatePolicy.DYNAMIC is supported.

Author:

Andrey Malykhanov

Nested Class Summary

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.LineVisualSet

LineVisualSet.InterpolationType, LineVisualSet.LineDrawingPolicy, LineVisualSet.LineVisualElement

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

AbstractLineVisualSet.AbstractLineVisualElement, AbstractLineVisualSet.Extrapolation, AbstractLineVisualSet.PointsAndLinesStyle

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Supplier<Double>	axisLengthInPixelsExtractor
protected Supplier<Double>	currentArgumentExtractor
protected Function<DoubleConsumer,List<Pair<Double,Double>>>	dataElementsOverrideProvider	Provider of the data elements displayed instead of the discretized PiecewiseFunction, null by default
protected Supplier<Boolean>	discretizeIfNecessaryExtractor
protected Supplier<Pair<Double,Double>>	displayedRangeExtractor
protected Supplier<Integer>	minPixelsPerPlotPointExtractor
protected Supplier<PiecewiseFunction>	piecewiseFunctionExtractor
protected PiecewiseFunction.InterpolationType	piecewiseFunctionInterpolationType
protected PiecewiseVisualSetRangePolicy	piecewiseVisualSetRangePolicy
protected static final double	STEP_CHANGE_SHIFT_IN_PIXELS	The argument shift (in pixels) of the point preceding a step change, used to draw the step change as a vertical line with the LINEAR interpolation type

Fields inherited from class com.amalgamasimulation.visualsets.LineVisualSet

clipboardTextExtractor, includeWhenCopyingToClipboard, interpolationType, lineDrawingPolicy, stackFillColor, stackVisible

Fields inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

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

Fields inherited from class com.amalgamasimulation.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
PiecewiseLineVisualSet(String name, Supplier<PiecewiseFunction> piecewiseFunctionExtractor, Supplier<Pair<Double,Double>> displayedRangeExtractor, Supplier<Double> axisLengthInPixelsExtractor)	Constructs a PiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.

Method Summary

Modifier and Type	Method	Description
PiecewiseLineVisualSet	addContextMenuHandler(VisualSet.ContextMenuHandler<Pair<Double,Double>> contextMenuHandler)	Adds the action to be executed every time a context menu for given data element is called.
PiecewiseLineVisualSet	addMouseEnterHandler(BiConsumer<Pair<Double,Double>,MouseEvent> handler)	Adds the action to be executed every time mouse enters to any visual element borders.
PiecewiseLineVisualSet	addMouseExitHandler(BiConsumer<Pair<Double,Double>,MouseEvent> handler)	Adds the action to be executed every time the mouse exits the previously entered element's bounds.
PiecewiseLineVisualSet	addMousePressedHandler(BiConsumer<Pair<Double,Double>,MouseEvent> handler)	Adds the action to be executed every time a mouse button is pressed.
PiecewiseLineVisualSet	addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)	Adds the action to be executed every time the visibility of this VisualSet is changed.
double	getAxisLengthInPixels()	Returns an actual plot X-axis length in pixels.
List<Pair<Double,Double>>	getContents()	Returns the list of visual set contents.
double	getCurrentArgument()	Returns a current argument shown on plot.
protected List<Pair<Double,Double>>	getDisplayedPlotPoints(DoubleConsumer appliedDiscretizationFactorConsumer)
Pair<Double,Double>	getDisplayedRange()	Returns a current displayed range on plot.
protected List<Pair<Double,Double>>	getLinearContents(List<Pair<Double,Double>> plotPoints)	Converts the PiecewiseFunction plot points to the data elements for the LINEAR interpolation type.
int	getMinPixelsPerPlotPoint()	Returns the minimum pixels per plot point for discretization.
PiecewiseFunction	getPiecewiseFunction()	Returns data elements list provider.
PiecewiseFunction.InterpolationType	getPiecewiseFunctionInterpolationType()	Returns the InterpolationType e.g.
PiecewiseVisualSetRangePolicy	getPiecewiseVisualSetRangePolicy()	Returns the PiecewiseVisualSetRangePolicy for discretization.
protected List<Pair<Double,Double>>	getPlotPointsWithDiscretizationGrid(List<Pair<Double,Double>> plotPoints, double discretizationFactor)	Restores the discretization grid points omitted by the PiecewiseFunction plot points (the plot points of the collinear segments are merged), so that every discretization step is represented by its own point.
protected double	getStepChangeArgumentShift()
protected List<Pair<Double,Double>>	getStepContents(List<Pair<Double,Double>> plotPoints, boolean peakDiscretized)	Converts the PiecewiseFunction plot points to the data elements for the STEP interpolation type: a single point per argument, its value is held until the next argument.
VisualSet.UpdatePolicy	getUpdatePolicy()	Return the current VisualSet.UpdatePolicy.
boolean	isDiscretizeIfNecessary()	Returns the necessity rule for discretization.
PiecewiseLineVisualSet	setAxisLengthInPixelsExtractor(Supplier<Double> axisLengthInPixelsExtractor)	Sets a function that specifies the rule for extracting an actual plot X-axis length in pixels.
PiecewiseLineVisualSet	setClipboardText(Function<Double,String> clipboardTextExtractor)	Sets the conversion method from values of each plot data element into text that will be copied to clipboard.
PiecewiseLineVisualSet	setCurrentArgumentExtractor(Supplier<Double> currentArgumentExtractor)	Sets a function that specifies the rule for extracting a current argument shown on plot.
void	setDataElementsOverrideProvider(Function<DoubleConsumer,List<Pair<Double,Double>>> dataElementsOverrideProvider)	Sets a provider of the data elements (plot points) displayed instead of the discretized PiecewiseFunction, or null to display the discretized PiecewiseFunction.
PiecewiseLineVisualSet	setDiscretizeIfNecessaryExtractor(Supplier<Boolean> discretizeIfNecessaryExtractor)	Sets a function that specifies the necessity rule for discretization.
PiecewiseLineVisualSet	setDisplayedRangeExtractor(Supplier<Pair<Double,Double>> displayedRangeExtractor)	Sets a function that specifies the rule for extracting a current displayed range on plot.
PiecewiseLineVisualSet	setExtrapolation(AbstractLineVisualSet.Extrapolation extrapolation)	Sets the of the plot i.e.
PiecewiseLineVisualSet	setIncludeWhenCopyingToClipboard(Supplier<Boolean> includeWhenCopyingToClipboard)	Sets the supplier of the property includeWhenCopyingToClipboard.
PiecewiseLineVisualSet	setInterpolationType(LineVisualSet.InterpolationType interpolationType)	Sets the new LineVisualSet.InterpolationType i.e.
PiecewiseLineVisualSet	setLegendText(Supplier<String> legendTextProvider)	Sets the legend label text represents this visual set.
PiecewiseLineVisualSet	setLineColor(Color color)	Sets the line color of the plot.
PiecewiseLineVisualSet	setLineDrawingPolicy(LineVisualSet.LineDrawingPolicy lineDrawingPolicy)	Sets the new LineVisualSet.LineDrawingPolicy i.e.
PiecewiseLineVisualSet	setLineStyle(LineStyle lineStyle)	Sets the LineStyle of the plot i.e.
PiecewiseLineVisualSet	setLineWidth(double width)	Sets the width of the line, in pixels.
void	setMaxArgument(double maxArgument)
PiecewiseLineVisualSet	setMaxValue(Supplier<Double> maxValueProvider)	Sets the supplier of max value.
void	setMinArgument(double minArgument)
PiecewiseLineVisualSet	setMinPixelsPerPlotPointExtractor(Supplier<Integer> minPixelsPerPlotPointExtractor)	Sets a function that specifies the minimum pixels per plot point for discretization.
PiecewiseLineVisualSet	setMouseTransparent(boolean mouseTransparent)	Sets the value of the property mouseTransparent.
PiecewiseLineVisualSet	setPiecewiseFunctionExtractor(Supplier<PiecewiseFunction> piecewiseFunctionExtractor)	Sets data elements list provider.
PiecewiseLineVisualSet	setPiecewiseFunctionInterpolationType(PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType)	Sets the InterpolationType e.g.
PiecewiseLineVisualSet	setPiecewiseVisualSetRangePolicy(PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy)	Sets an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.
PiecewiseLineVisualSet	setPointsAndLinesStyle(AbstractLineVisualSet.PointsAndLinesStyle pointsAndLinesStyle)	Sets the AbstractLineVisualSet.PointsAndLinesStyle of the plot i.e.
PiecewiseLineVisualSet	setPointSize(double pointSize)	Sets the diameter of the point, in pixels.
PiecewiseLineVisualSet	setStackFillColor(Color stackFillColor)	Sets the color of a stack visual element.
PiecewiseLineVisualSet	setStackVisible(boolean stackVisible)	Sets the visibility of a stack visual element.
PiecewiseLineVisualSet	setTooltipText(Function<Pair<Double,Double>,String> tooltipTextExtractor)	Adds tooltip text to display when the mouse is hovered over a visual element representing given data element.
PiecewiseLineVisualSet	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.
protected void	updateMinMaxArguments()

Methods inherited from class com.amalgamasimulation.visualsets.LineVisualSet

createVisualElement, getClipboardText, getInterpolationType, getLegendColor, getLineDrawingPolicy, getStackFillColor, getVisualElements, isIncludeWhenCopyingToClipboard, isStackVisible

Methods inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

getExtrapolation, getLegendText, getLineColor, getLineStyle, getLineWidth, getMaxValue, getMinValue, getPointsAndLinesStyle, getPointSize, getValue, getValueMultiplier, getValueShift, withValueMultiplier, withValueShift

Methods inherited from class com.amalgamasimulation.visualsets.VisualSet

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContextMenuHandlers, getDataElements, getInjectionIndex, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, 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.visualsets.types.IAbstractChartVisualSet

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

Methods inherited from interface com.amalgamasimulation.visualsets.IPiecewiseVisualSet

getDiscretizationFactor, getDiscretizedDataElements, getDiscretizedDataElements, getDiscretizedFunction, getDisplayedInterval, getMaxArgument, getPlotPoints, getRequiredDiscretizationFactor, invalidatePiecewiseMinMaxArguments

Field Details

STEP_CHANGE_SHIFT_IN_PIXELS

protected static final double STEP_CHANGE_SHIFT_IN_PIXELS

The argument shift (in pixels) of the point preceding a step change, used to draw the step change as a vertical line with the LINEAR interpolation type

See Also:

• Constant Field Values

piecewiseVisualSetRangePolicy

protected PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy

piecewiseFunctionInterpolationType

protected PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType

piecewiseFunctionExtractor

protected Supplier<PiecewiseFunction> piecewiseFunctionExtractor

displayedRangeExtractor

protected Supplier<Pair<Double,Double>> displayedRangeExtractor

axisLengthInPixelsExtractor

protected Supplier<Double> axisLengthInPixelsExtractor

discretizeIfNecessaryExtractor

protected Supplier<Boolean> discretizeIfNecessaryExtractor

minPixelsPerPlotPointExtractor

protected Supplier<Integer> minPixelsPerPlotPointExtractor

currentArgumentExtractor

protected Supplier<Double> currentArgumentExtractor

dataElementsOverrideProvider

protected Function<DoubleConsumer,List<Pair<Double,Double>>> dataElementsOverrideProvider

Provider of the data elements displayed instead of the discretized PiecewiseFunction, null by default

Constructor Details

PiecewiseLineVisualSet

public PiecewiseLineVisualSet(String name,
 Supplier<PiecewiseFunction> piecewiseFunctionExtractor,
 Supplier<Pair<Double,Double>> displayedRangeExtractor,
 Supplier<Double> axisLengthInPixelsExtractor)

Constructs a PiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.

The extrapolation is disabled by default, as the data is already extended to the current argument (see setCurrentArgumentExtractor(Supplier)).

Parameters:

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

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

displayedRangeExtractor - a function that specifies the rule for extracting a current displayed range on plot

axisLengthInPixelsExtractor - a function that specifies the rule for extracting an actual plot X-axis length in pixels

Method Details

setDataElementsOverrideProvider

public void setDataElementsOverrideProvider(Function<DoubleConsumer,List<Pair<Double,Double>>> dataElementsOverrideProvider)

Sets a provider of the data elements (plot points) displayed instead of the discretized PiecewiseFunction, or null to display the discretized PiecewiseFunction. The provider accepts the consumer of the applied discretization factor (step), which must be called only if the data elements are discretized.

Is used by the visual set container to display the visual set as a part of a stack.

Parameters:

dataElementsOverrideProvider - the data elements provider or null

getDisplayedPlotPoints

protected List<Pair<Double,Double>> getDisplayedPlotPoints(DoubleConsumer appliedDiscretizationFactorConsumer)

setPiecewiseFunctionExtractor

public PiecewiseLineVisualSet setPiecewiseFunctionExtractor(Supplier<PiecewiseFunction> piecewiseFunctionExtractor)

Description copied from interface: IPiecewiseVisualSet

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

Specified by:

setPiecewiseFunctionExtractor in interface IPiecewiseVisualSet

Parameters:

piecewiseFunctionExtractor - data elements list provider

Returns:

reference to this object

setPiecewiseVisualSetRangePolicy

public PiecewiseLineVisualSet setPiecewiseVisualSetRangePolicy(PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy)

Description copied from interface: IPiecewiseVisualSet

Sets an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.

Specified by:

setPiecewiseVisualSetRangePolicy in interface IPiecewiseVisualSet

Parameters:

piecewiseVisualSetRangePolicy - an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.

Returns:

reference to this object

setDiscretizeIfNecessaryExtractor

public PiecewiseLineVisualSet setDiscretizeIfNecessaryExtractor(Supplier<Boolean> discretizeIfNecessaryExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the necessity rule for discretization.

Specified by:

setDiscretizeIfNecessaryExtractor in interface IPiecewiseVisualSet

Parameters:

discretizeIfNecessaryExtractor - a function that specifies the necessity rule for discretization

Returns:

reference to this object

setMinPixelsPerPlotPointExtractor

public PiecewiseLineVisualSet setMinPixelsPerPlotPointExtractor(Supplier<Integer> minPixelsPerPlotPointExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the minimum pixels per plot point for discretization.

Specified by:

setMinPixelsPerPlotPointExtractor in interface IPiecewiseVisualSet

Parameters:

minPixelsPerPlotPointExtractor - a function that specifies the minimum pixels per plot point for discretization

Returns:

reference to this object

setDisplayedRangeExtractor

public PiecewiseLineVisualSet setDisplayedRangeExtractor(Supplier<Pair<Double,Double>> displayedRangeExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting a current displayed range on plot.

Specified by:

setDisplayedRangeExtractor in interface IPiecewiseVisualSet

Parameters:

displayedRangeExtractor - a function that specifies the rule for extracting a current displayed range on plot

Returns:

reference to this object

setAxisLengthInPixelsExtractor

public PiecewiseLineVisualSet setAxisLengthInPixelsExtractor(Supplier<Double> axisLengthInPixelsExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting an actual plot X-axis length in pixels.

Specified by:

setAxisLengthInPixelsExtractor in interface IPiecewiseVisualSet

Parameters:

axisLengthInPixelsExtractor - a function that specifies the rule for extracting an actual plot X-axis length in pixels

Returns:

reference to this object

setPiecewiseFunctionInterpolationType

public PiecewiseLineVisualSet setPiecewiseFunctionInterpolationType(PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType)

Description copied from interface: IPiecewiseVisualSet

Sets the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points. InterpolationType.PEAK used by default.

Specified by:

setPiecewiseFunctionInterpolationType in interface IPiecewiseVisualSet

Parameters:

piecewiseFunctionInterpolationType - the interpolation method between PiecewiseFunction grid points.

Returns:

reference to this object

setCurrentArgumentExtractor

public PiecewiseLineVisualSet setCurrentArgumentExtractor(Supplier<Double> currentArgumentExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting a current argument shown on plot.

Specified by:

setCurrentArgumentExtractor in interface IPiecewiseVisualSet

Parameters:

currentArgumentExtractor - a function that specifies the rule for extracting a current argument shown on plot

Returns:

reference to this object

getCurrentArgument

public double getCurrentArgument()

Description copied from interface: IPiecewiseVisualSet

Returns a current argument shown on plot.

Specified by:

getCurrentArgument in interface IPiecewiseVisualSet

Returns:

a current argument shown on plot

getPiecewiseFunction

public PiecewiseFunction getPiecewiseFunction()

Description copied from interface: IPiecewiseVisualSet

Returns data elements list provider.

Specified by:

getPiecewiseFunction in interface IPiecewiseVisualSet

Returns:

data elements list provider.

getPiecewiseVisualSetRangePolicy

public PiecewiseVisualSetRangePolicy getPiecewiseVisualSetRangePolicy()

Description copied from interface: IPiecewiseVisualSet

Returns the PiecewiseVisualSetRangePolicy for discretization.

Specified by:

getPiecewiseVisualSetRangePolicy in interface IPiecewiseVisualSet

Returns:

the PiecewiseVisualSetRangePolicy for discretization

isDiscretizeIfNecessary

public boolean isDiscretizeIfNecessary()

Description copied from interface: IPiecewiseVisualSet

Returns the necessity rule for discretization.

Specified by:

isDiscretizeIfNecessary in interface IPiecewiseVisualSet

Returns:

the necessity rule for discretization

getMinPixelsPerPlotPoint

public int getMinPixelsPerPlotPoint()

Description copied from interface: IPiecewiseVisualSet

Returns the minimum pixels per plot point for discretization.

Specified by:

getMinPixelsPerPlotPoint in interface IPiecewiseVisualSet

Returns:

the minimum pixels per plot point for discretization

getDisplayedRange

public Pair<Double,Double> getDisplayedRange()

Description copied from interface: IPiecewiseVisualSet

Returns a current displayed range on plot.

Specified by:

getDisplayedRange in interface IPiecewiseVisualSet

Returns:

a current displayed range on plot

getAxisLengthInPixels

public double getAxisLengthInPixels()

Description copied from interface: IPiecewiseVisualSet

Returns an actual plot X-axis length in pixels.

Specified by:

getAxisLengthInPixels in interface IPiecewiseVisualSet

Returns:

an actual plot X-axis length in pixels

getPiecewiseFunctionInterpolationType

public PiecewiseFunction.InterpolationType getPiecewiseFunctionInterpolationType()

Description copied from interface: IPiecewiseVisualSet

Returns the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points.

Specified by:

getPiecewiseFunctionInterpolationType in interface IPiecewiseVisualSet

Returns:

the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points.

updateMinMaxArguments

protected void updateMinMaxArguments()

Overrides:

updateMinMaxArguments in class VisualSet<Pair<Double,Double>>

setMinArgument

public void setMinArgument(double minArgument)

Specified by:

setMinArgument in interface IPiecewiseVisualSet

setMaxArgument

public void setMaxArgument(double maxArgument)

Specified by:

setMaxArgument in interface IPiecewiseVisualSet

getContents

public List<Pair<Double,Double>> getContents()

Description copied from interface: IAbstractChartVisualSet

Returns the list of visual set contents.

Specified by:

getContents in interface IAbstractChartVisualSet

Overrides:

getContents in class LineVisualSet<Pair<Double,Double>>

Returns:

the list of visual set contents

getPlotPointsWithDiscretizationGrid

protected List<Pair<Double,Double>> getPlotPointsWithDiscretizationGrid(List<Pair<Double,Double>> plotPoints,
 double discretizationFactor)

Restores the discretization grid points omitted by the PiecewiseFunction plot points (the plot points of the collinear segments are merged), so that every discretization step is represented by its own point.

getStepContents

protected List<Pair<Double,Double>> getStepContents(List<Pair<Double,Double>> plotPoints,
 boolean peakDiscretized)

Converts the PiecewiseFunction plot points to the data elements for the STEP interpolation type: a single point per argument, its value is held until the next argument. The value after the step change at the argument is used, or, for the PEAK discretization, the value before the step change at the next argument, i.e. the peak value of the discretization step.

getLinearContents

protected List<Pair<Double,Double>> getLinearContents(List<Pair<Double,Double>> plotPoints)

Converts the PiecewiseFunction plot points to the data elements for the LINEAR interpolation type. The point preceding a step change is shifted to the left by a fraction of a pixel, so that the step change is drawn as a vertical line while the arguments remain strictly increasing.

getStepChangeArgumentShift

protected double getStepChangeArgumentShift()

setUpdatePolicy

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

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

Returns:

reference to this object

getUpdatePolicy

public VisualSet.UpdatePolicy getUpdatePolicy()

Description copied from interface: IAbstractChartVisualSet

Return the current VisualSet.UpdatePolicy.

Specified by:

getUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

getUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

getUpdatePolicy in class VisualSet<Pair<Double,Double>>

Returns:

the current VisualSet.UpdatePolicy

setLineDrawingPolicy

public PiecewiseLineVisualSet setLineDrawingPolicy(LineVisualSet.LineDrawingPolicy lineDrawingPolicy)

Description copied from class: LineVisualSet

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

Overrides:

setLineDrawingPolicy in class LineVisualSet<Pair<Double,Double>>

Parameters:

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

Returns:

reference to this object

setInterpolationType

public PiecewiseLineVisualSet setInterpolationType(LineVisualSet.InterpolationType interpolationType)

Description copied from class: LineVisualSet

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

Overrides:

setInterpolationType in class LineVisualSet<Pair<Double,Double>>

Parameters:

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

Returns:

reference to this object

setStackVisible

public PiecewiseLineVisualSet setStackVisible(boolean stackVisible)

Description copied from class: LineVisualSet

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.

Overrides:

setStackVisible in class LineVisualSet<Pair<Double,Double>>

Parameters:

stackVisible - new visibility of a stack visual element

Returns:

reference to this object

setStackFillColor

public PiecewiseLineVisualSet setStackFillColor(Color stackFillColor)

Description copied from class: LineVisualSet

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.

Overrides:

setStackFillColor in class LineVisualSet<Pair<Double,Double>>

Parameters:

stackFillColor - new color of a stack visual element

Returns:

reference to this object

setExtrapolation

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

extrapolation - the AbstractLineVisualSet.Extrapolation of the plot

Returns:

reference to this object

setClipboardText

public PiecewiseLineVisualSet 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<Double>

Overrides:

setClipboardText in class LineVisualSet<Pair<Double,Double>>

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 PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

color - the line color of the plot

Returns:

reference to this object

setTooltipText

public PiecewiseLineVisualSet setTooltipText(Function<Pair<Double,Double>,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.

Overrides:

setTooltipText in class LineVisualSet<Pair<Double,Double>>

Parameters:

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

Returns:

reference to this object

setLineWidth

public PiecewiseLineVisualSet setLineWidth(double width)

Description copied from class: AbstractLineVisualSet

Sets the width of the line, in pixels.

Overrides:

setLineWidth in class LineVisualSet<Pair<Double,Double>>

Parameters:

width - the width of the line, in pixels

Returns:

reference to this object

setPointSize

public PiecewiseLineVisualSet setPointSize(double pointSize)

Description copied from class: AbstractLineVisualSet

Sets the diameter of the point, in pixels.

Overrides:

setPointSize in class LineVisualSet<Pair<Double,Double>>

Parameters:

pointSize - the diameter of the point, in pixels

Returns:

reference to this object

setLegendText

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

legendTextProvider - the legend label text represents this visual set

Returns:

reference to this object

setPointsAndLinesStyle

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

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

setIncludeWhenCopyingToClipboard

public PiecewiseLineVisualSet setIncludeWhenCopyingToClipboard(Supplier<Boolean> includeWhenCopyingToClipboard)

Description copied from interface: IClipboardTextPropertyOwner

Sets the supplier of the property includeWhenCopyingToClipboard. If true, this VisualSet is included when chart's data is copying to clipboard.

Specified by:

setIncludeWhenCopyingToClipboard in interface IClipboardTextPropertyOwner<Double>

Overrides:

setIncludeWhenCopyingToClipboard in class LineVisualSet<Pair<Double,Double>>

Parameters:

includeWhenCopyingToClipboard - new supplier of property includeWhenCopyingToClipboard

Returns:

reference to this object

setLineStyle

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

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 PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

maxValueProvider - the supplier of max value

Returns:

reference to this object

addContextMenuHandler

public PiecewiseLineVisualSet addContextMenuHandler(VisualSet.ContextMenuHandler<Pair<Double,Double>> 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 LineVisualSet<Pair<Double,Double>>

Parameters:

contextMenuHandler - context menu call action

Returns:

reference to this object

addMouseEnterHandler

public PiecewiseLineVisualSet addMouseEnterHandler(BiConsumer<Pair<Double,Double>,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 LineVisualSet<Pair<Double,Double>>

Parameters:

handler - new mouse enter action

Returns:

reference to this object

addMouseExitHandler

public PiecewiseLineVisualSet addMouseExitHandler(BiConsumer<Pair<Double,Double>,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 LineVisualSet<Pair<Double,Double>>

Parameters:

handler - new mouse exit action

Returns:

reference to this object

addMousePressedHandler

public PiecewiseLineVisualSet addMousePressedHandler(BiConsumer<Pair<Double,Double>,MouseEvent> handler)

Description copied from class: VisualSet

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

Overrides:

addMousePressedHandler in class LineVisualSet<Pair<Double,Double>>

Parameters:

handler - new mouse button pressed action

Returns:

reference to this object

addVisibilityChangeHandler

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

visibilityChangeHandler - visibility change action

Returns:

reference to this object

setMouseTransparent

public PiecewiseLineVisualSet 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 LineVisualSet<Pair<Double,Double>>

Parameters:

mouseTransparent - new value of property mouseTransparent

Returns:

reference to this object