Package com.amalgamasimulation.charts.visualsets

Class WaterfallVisualSet<T>

java.lang.Object

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

com.amalgamasimulation.charts.visualsets.BarLabeledVisualSet<T,WaterfallVisualSet.Category>

com.amalgamasimulation.charts.visualsets.BarVisualSet<T,WaterfallVisualSet.Category>

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

Type Parameters:

T - the type of elements in the visual set

All Implemented Interfaces:

IAbstractBarVisualSet<T,WaterfallVisualSet.Category>, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, IBarChartVisualSet

public class WaterfallVisualSet<T>
extends BarVisualSet<T,WaterfallVisualSet.Category>

Represents a Waterfall visual set that extends BarVisualSet and visualizes data in a waterfall format. This format is designed to display cumulative effect of sequentially introduced positive or negative values.

Can be shown on a BarChart with BarsLayout == BarsLayout.STACK.

Author:

Andrey Malykhanov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WaterfallVisualSet.Category	Defines the category of a bar (data element) in the waterfall chart.
static enum	WaterfallVisualSet.ElementType	Defines the type of element represented in the waterfall chart.

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

BarVisualSet.BarVisualElement

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

BarLabeledVisualSet.BarLabeledVisualElement

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

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

Field Summary

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

barLabelColorExtractor, barLabelFontSizeExtractor, barLabelTextExtractor, labelColorExtractors, labelFontSizeExtractors, labelTextExtractors

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
WaterfallVisualSet(String name, List<T> elements, Function<T,Double> valueExtractor, Function<T,WaterfallVisualSet.ElementType> typeExtractor)	Constructs a new WaterfallVisualSet with the specified parameters.

Method Summary

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

addContextMenuHandler, addMouseEnterHandler, addMouseExitHandler, addMousePressedHandler, addVisibilityChangeHandler, createVisualElement, getBackgroundColor, getBorderColor, getBorderWidth, getCategories, getColumnWidthFraction, getElementText, getLegendLabelText, getMaxArgument, getMaxGroupValue, getMaxGroupValue, getMaxValueByAnyCategory, getMaxValueByAnyCategory, getMinArgument, getPercentOfMaxValue, getPercentOfMaxValue, getSummaryValue, getSummaryValue, getValue, getVisualElements, getVisualWidthFraction, setBackgroundColor, setBarLabelColor, setBarLabelFontSize, setBarLabelText, setBorderColor, setBorderWidth, setCategoriesComparator, setColumnWidthFraction, setElementText, setLabelText, setLegendLabelText, setMouseTransparent, setTooltipText, setUpdatePolicy, setVisualWidthFraction

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

getBarLabelColor, getBarLabelFontSize, getBarLabelText, getLabelColor, getLabelFontSize, getLabelSides, getLabelText

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

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContents, getContextMenuHandlers, getDataElements, getInjectionIndex, 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, getContents, getName, getUpdatePolicy, getVisibilityChangeHandlers, getVisibleVisualElementsCount, isMouseTransparent, removeVisibilityChangeHandler, removeVisualSetChangeHandler

Constructor Details

WaterfallVisualSet

public WaterfallVisualSet(String name,
 List<T> elements,
 Function<T,Double> valueExtractor,
 Function<T,WaterfallVisualSet.ElementType> typeExtractor)

Constructs a new WaterfallVisualSet with the specified parameters.

Parameters:

name - the name of the visual set

elements - the list of elements to visualize

valueExtractor - a function to extract the value from each element

typeExtractor - a function to determine the WaterfallVisualSet.ElementType of each element - must it be shown as an absolute value or as a delta from from the previous value.