com.amalgamasimulation.charts.visualsets.HistogramVisualSet<T,C>

Type Parameters:: T - visual set data elements type; C - data categories type

All Implemented Interfaces:: IAbstractBarVisualSet<T,C>, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, IBarChartVisualSet

public class HistogramVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C> extends BarLabeledVisualSet<T,C> implements IAbstractBarVisualSet<T,C>, IBarChartVisualSet

Visual set for drawing bars.

Can be drawn on HistogramChart.

Used to draw histograms, possibly with categories. The histogram divides all statistical data into a number of buckets and estimates how frequently the data falls within each bucket.

Author:: Aleksey Kirillov

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

HistogramVisualSet.ExtractValuePolicy

Enum defining how values are retrieved from a statistical data.

class

HistogramVisualSet.HistogramVisualElement

Internal class that represents visual element for histogram data element.

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

HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator)

Constructs a HistogramVisualSet with given name and histogram data aggregator.

HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, boolean cleanEmptyGroups)

Constructs a HistogramVisualSet with given name and histogram data aggregator.

HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, HistogramVisualSet.ExtractValuePolicy extractValuePolicy)

Constructs a HistogramVisualSet with given name and histogram data aggregator.

HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, HistogramVisualSet.ExtractValuePolicy extractValuePolicy, boolean cleanEmptyGroups)

Constructs a HistogramVisualSet with given name and histogram data aggregator.
Method Summary

Modifier and Type

Method

Description

HistogramVisualSet<T,C>

addContextMenuHandler(VisualSet.ContextMenuHandler<T> contextMenuHandler)

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

HistogramVisualSet<T,C>

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

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

HistogramVisualSet<T,C>

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.

HistogramVisualSet<T,C>

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

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

HistogramVisualSet<T,C>

addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> visibilityChangeHandler)

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

HistogramVisualSet<T,C>.HistogramVisualElement

createVisualElement(T contents)

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

Color

getBackgroundColor(C category)

Returns the background color for given category.

Color

getBarLabelColor(T element)

Returns the bar label color for given data element.

double

getBarLabelFontSize(T element)

Returns the bar label font size for given data element.

HistogramDataAggregator<C,?>.HistogramDataGroup

getBiggestGroup()

Returns the HistogramDataAggregator.HistogramDataGroup i.e.

Color

getBorderColor(C category)

Returns the border color for given category.

double

getBorderWidth(C category)

Returns the border width in pixels for given category.

List<C>

getCategories()

Returns the list of data categories.

double

getColumnWidthFraction()

Returns the width fraction to region allocated for each individual category-bar.

String

getElementText(T element)

Returns the label text for each data element.

HistogramVisualSet.ExtractValuePolicy

getExtractValuePolicy()

Returns the current HistogramVisualSet.ExtractValuePolicy i.e.

HistogramDataAggregator<C,?>

getHistogramDataAggregator()

Returns the current HistogramDataAggregator i.e.

String

getLegendLabelText(C category)

Returns the legend label text for given category.

double

getMaxArgument()

Returns the maximum possible value that stored in the current data elements list.

double

getMaxGroupValue()

Returns the maximum value for any data group within all existed data elements.

double

getMaxGroupValue(Predicate<C> categoryPredicate)

Returns the maximum value for any data group within all existed data elements.

double

getMaxValueByAnyCategory()

Returns the maximum value for any category within all existed data elements.

double

getMaxValueByAnyCategory(Predicate<C> categoryPredicate)

Returns the maximum value between given filtered categories within all existed data elements.

double

getMinArgument()

Returns the minimum possible value that stored in the current data elements list.

double

getPercentOfMaxValue()

Returns the ratio of the value for the maximum group to the total sum of the all values across the entire statistics.

double

getPercentOfMaxValue(Predicate<C> categoryPredicate)

Returns the ratio of the value for the maximum group to the total sum of the all values across the entire statistics.

double

getSummaryValue(T element)

Returns the total value for all categories within the given data element.

double

getSummaryValue(T element, Predicate<C> categoryPredicate)

Returns the total value for specified categories within the specified data element.

double

getValue(T element, C category)

Returns the value for given category within the given data element.

List<HistogramVisualSet<T,C>.HistogramVisualElement>

getVisualElements(boolean recalculationRequired)

Returns the list of visual elements corresponding to current data elements.

HistogramVisualSet<T,C>

setBackgroundColor(Function<C,Color> backgroundColorExtractor)

Sets the background color for each category.

HistogramVisualSet<T,C>

setBarLabelColor(Function<T,Color> barLabelColorExtractor)

Sets the label color for each visual element.

HistogramVisualSet<T,C>

setBarLabelFontSize(Function<T,Double> barLabelFontSizeExtractor)

Sets the label font size for each visual element.

HistogramVisualSet<T,C>

setBarLabelText(Function<T,String> barLabelTextExtractor)

Sets the label text for each visual element.

HistogramVisualSet<T,C>

setBorderColor(Function<C,Color> borderColorExtractor)

Sets the border color for each category.

HistogramVisualSet<T,C>

setBorderWidth(Function<C,Double> borderWidthExtractor)

Sets the border width in pixels for each category.

HistogramVisualSet<T,C>

setColumnWidthFraction(double columnWidthFraction)

Sets the width fraction to region allocated for each individual category-bar.

HistogramVisualSet<T,C>

setElementText(Function<T,String> elementTextExtractor)

Sets the label text for each data element.

HistogramVisualSet<T,C>

setLabelText(LabelSide labelSide, BiFunction<T,C,String> labelText, BiFunction<T,C,Double> labelTextSize, BiFunction<T,C,Color> labelTextColor)

Sets the labels of the bars representing plot data elements.

HistogramVisualSet<T,C>

setLegendLabelText(Function<C,String> legendLabelTextExtractor)

Sets the legend label text for each category.

HistogramVisualSet<T,C>

setMouseTransparent(boolean mouseTransparent)

Sets the value of the property mouseTransparent.

HistogramVisualSet<T,C>

setTooltipText(Function<T,String> tooltipTextExtractor)

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

HistogramVisualSet<T,C>

setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)

Sets the new VisualSet.UpdatePolicy i.e.

Methods inherited from class com.amalgamasimulation.charts.visualsets.BarLabeledVisualSet
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
- HistogramVisualSet
  
  public HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator)
  
  Constructs a HistogramVisualSet with given name and histogram data aggregator. The data aggregator stores statistical data and provides a set of methods for analyzing this data.
  Parameters:
  
  name - visual set name is used to sort and name the visual sets on the chart
  
  histogramDataAggregator - statistical data aggregator
  
  See Also:
  
  HistogramDataAggregator
- HistogramVisualSet
  
  public HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, boolean cleanEmptyGroups)
  
  Constructs a HistogramVisualSet with given name and histogram data aggregator. The data aggregator stores statistical data and provides a set of methods for analyzing this data.
  Parameters:
  
  name - visual set name is used to sort and name the visual sets on the chart
  
  histogramDataAggregator - statistical data aggregator
  
  cleanEmptyGroups - if true, empty data groups in histogramDataAggregator will be removed until the 1st non-empty data group is found or there is only 1 data group left
  
  See Also:
  
  HistogramDataAggregator
- HistogramVisualSet
  
  public HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, HistogramVisualSet.ExtractValuePolicy extractValuePolicy)
  
  Constructs a HistogramVisualSet with given name and histogram data aggregator. The data aggregator stores statistical data and provides a set of methods for analyzing this data.
  Parameters:
  
  name - visual set name is used to sort and name the visual sets on the chart
  
  histogramDataAggregator - statistical data aggregator
  
  extractValuePolicy - HistogramVisualSet.ExtractValuePolicy is defining how values are retrieved from a statistical data
  
  See Also:
  
  HistogramDataAggregator
- HistogramVisualSet
  
  public HistogramVisualSet(String name, HistogramDataAggregator<C,?> histogramDataAggregator, HistogramVisualSet.ExtractValuePolicy extractValuePolicy, boolean cleanEmptyGroups)
  
  Constructs a HistogramVisualSet with given name and histogram data aggregator. The data aggregator stores statistical data and provides a set of methods for analyzing this data.
  Parameters:
  
  name - visual set name is used to sort and name the visual sets on the chart
  
  histogramDataAggregator - statistical data aggregator
  
  extractValuePolicy - HistogramVisualSet.ExtractValuePolicy is defining how values are retrieved from a statistical data
  
  cleanEmptyGroups - if true, empty data groups in histogramDataAggregator will be removed until the 1st non-empty data group is found or there is only 1 data group left
  
  See Also:
  
  HistogramDataAggregator
Method Details
- getExtractValuePolicy
  
  public HistogramVisualSet.ExtractValuePolicy getExtractValuePolicy()
  
  Returns the current HistogramVisualSet.ExtractValuePolicy i.e. the enum is defining how values are retrieved from a statistical data.
  
  Returns:
  
  the current HistogramVisualSet.ExtractValuePolicy i.e. the enum is defining how values are retrieved from a statistical data
- getHistogramDataAggregator
  
  public HistogramDataAggregator<C,?> getHistogramDataAggregator()
  
  Returns the current HistogramDataAggregator i.e. the class stores statistical data and provides a set of methods for analyzing this data.
  
  Returns:
  
  the current HistogramDataAggregator i.e. the class stores statistical data and provides a set of methods for analyzing this data
- getBiggestGroup
  
  public HistogramDataAggregator<C,?>.HistogramDataGroup getBiggestGroup()
  
  Returns the HistogramDataAggregator.HistogramDataGroup i.e. the range descriptor with maximum statistical data elements. The calculation method for the maximum group depends on the current HistogramVisualSet.ExtractValuePolicy.
  
  Returns:
  
  the HistogramDataAggregator.HistogramDataGroup i.e. the range descriptor with maximum statistical data elements
- setColumnWidthFraction
  
  public HistogramVisualSet<T,C> setColumnWidthFraction(double columnWidthFraction)
  
  Sets the width fraction to region allocated for each individual category-bar.
  The value must be greater than zero and not greater than 1.
  The default value is 0.8.
  
  Parameters:
  
  columnWidthFraction -
  
  Returns:
  
  reference to this object
- getColumnWidthFraction
  
  public double getColumnWidthFraction()
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the width fraction to region allocated for each individual category-bar.
  
  Specified by:
  
  getColumnWidthFraction in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Returns:
  
  the width fraction to region allocated for each individual category-bar
- setElementText
  
  public HistogramVisualSet<T,C> setElementText(Function<T,String> elementTextExtractor)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Sets the label text for each data element. This label is displayed on the ticks of the X-axis, below the corresponding bars.
  
  Specified by:
  
  setElementText in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  elementTextExtractor - the text of the bar label
  
  Returns:
  
  reference to this object
- setBarLabelText
  
  public HistogramVisualSet<T,C> setBarLabelText(Function<T,String> barLabelTextExtractor)
  
  Description copied from class: BarLabeledVisualSet
  
  Sets the label text for each visual element. This label is displayed above the corresponding bars.
  
  Overrides:
  
  setBarLabelText in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  barLabelTextExtractor - the text of the bar label
  
  Returns:
  
  reference to this object
- setBarLabelColor
  
  public HistogramVisualSet<T,C> setBarLabelColor(Function<T,Color> barLabelColorExtractor)
  
  Description copied from class: BarLabeledVisualSet
  
  Sets the label color for each visual element. This label is displayed above the corresponding bars.
  
  Overrides:
  
  setBarLabelColor in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  barLabelColorExtractor - the color of the bar label
  
  Returns:
  
  reference to this object
- setBarLabelFontSize
  
  public HistogramVisualSet<T,C> setBarLabelFontSize(Function<T,Double> barLabelFontSizeExtractor)
  
  Description copied from class: BarLabeledVisualSet
  
  Sets the label font size for each visual element. This label is displayed above the corresponding bars.
  
  Overrides:
  
  setBarLabelFontSize in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  barLabelFontSizeExtractor - the font size of the bar label
  
  Returns:
  
  reference to this object
- getElementText
  
  public String getElementText(T element)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the label text for each data element.
  
  Specified by:
  
  getElementText in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the label text is being checked
  
  Returns:
  
  the label text for each data element
- setLegendLabelText
  
  public HistogramVisualSet<T,C> setLegendLabelText(Function<C,String> legendLabelTextExtractor)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Sets the legend label text for each category.
  
  Specified by:
  
  setLegendLabelText in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  legendLabelTextExtractor - the legend label text extractor, i.e. method returning text depending on the category
  
  Returns:
  
  reference to this object
- setTooltipText
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  tooltipTextExtractor - a function that specifies the rule for extracting a tooltip text from a data element
  
  Returns:
  
  reference to this object
- setBackgroundColor
  
  public HistogramVisualSet<T,C> setBackgroundColor(Function<C,Color> backgroundColorExtractor)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Sets the background color for each category. The color may be different for different categories and it does not depend on different data elements. Also used to display a color icon in the Legend.
  
  Specified by:
  
  setBackgroundColor in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  backgroundColorExtractor - the background color extractor, i.e. method returning color depending on the category
  
  Returns:
  
  reference to this object
- setBorderColor
  
  public HistogramVisualSet<T,C> setBorderColor(Function<C,Color> borderColorExtractor)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Sets the border color for each category. The color may be different for different categories and it does not depend on different data elements.
  
  Specified by:
  
  setBorderColor in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  borderColorExtractor - the border color extractor, i.e. method returning color depending on the category
  
  Returns:
  
  reference to this object
- setBorderWidth
  
  public HistogramVisualSet<T,C> setBorderWidth(Function<C,Double> borderWidthExtractor)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Sets the border width in pixels for each category. The width may be different for different categories and it does not depend on different data elements.
  
  Specified by:
  
  setBorderWidth in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  borderWidthExtractor - the border width extractor, i.e. method returning the width depending on the category
  
  Returns:
  
  reference to this object
- getMinArgument
  
  public double getMinArgument()
  
  Description copied from interface: IAbstractChartVisualSet
  
  Returns the minimum possible value that stored in the current data elements list.
  
  Specified by:
  
  getMinArgument in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Specified by:
  
  getMinArgument in interface IAbstractChartVisualSet
  
  Overrides:
  
  getMinArgument in class VisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Returns:
  
  the minimum possible value that stored in the current data elements list
- getMaxArgument
  
  public double getMaxArgument()
  
  Description copied from interface: IAbstractChartVisualSet
  
  Returns the maximum possible value that stored in the current data elements list.
  
  Specified by:
  
  getMaxArgument in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Specified by:
  
  getMaxArgument in interface IAbstractChartVisualSet
  
  Overrides:
  
  getMaxArgument in class VisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Returns:
  
  the maximum possible value that stored in the current data elements list
- getCategories
  
  public List<C> getCategories()
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the list of data categories.
  
  Specified by:
  
  getCategories in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Returns:
  
  the list of data categories
- setUpdatePolicy
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule
  
  Returns:
  
  reference to this object
- getBackgroundColor
  
  public Color getBackgroundColor(C category)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the background color for given category.
  
  Specified by:
  
  getBackgroundColor in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  category - category for which the background color is being checked
  
  Returns:
  
  the background color for given category
- getBorderColor
  
  public Color getBorderColor(C category)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the border color for given category.
  
  Specified by:
  
  getBorderColor in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  category - category for which the border color is being checked
  
  Returns:
  
  the border color for given category
- getBorderWidth
  
  public double getBorderWidth(C category)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the border width in pixels for given category.
  
  Specified by:
  
  getBorderWidth in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  category - category for which the border width in pixels is being checked
  
  Returns:
  
  the border width in pixels for given category
- getLegendLabelText
  
  public String getLegendLabelText(C category)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the legend label text for given category.
  
  Specified by:
  
  getLegendLabelText in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  category - category for which the legend label text is being checked
  
  Returns:
  
  the legend label text for given category
- getPercentOfMaxValue
  
  public double getPercentOfMaxValue()
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the ratio of the value for the maximum group to the total sum of the all values across the entire statistics.
  
  Specified by:
  
  getPercentOfMaxValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Returns:
  
  the ratio of the value for the maximum group to the total sum of the all values across the entire statistics
- getPercentOfMaxValue
  
  public double getPercentOfMaxValue(Predicate<C> categoryPredicate)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the ratio of the value for the maximum group to the total sum of the all values across the entire statistics.
  Considers only the categories filtered by the corresponding predicate.
  
  Specified by:
  
  getPercentOfMaxValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  categoryPredicate - filter for categories for which the ratio is calculated
  
  Returns:
  
  the ratio of the value for the maximum group to the total sum of the all values across the entire statistics
- getMaxGroupValue
  
  public double getMaxGroupValue()
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the maximum value for any data group within all existed data elements. The data group in the case of a histogram is the range of the X-axis arguments, and in the case of a bar chart, each individual data element.
  
  Specified by:
  
  getMaxGroupValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Returns:
  
  the maximum value for any data group within all existed data elements
- getMaxGroupValue
  
  public double getMaxGroupValue(Predicate<C> categoryPredicate)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the maximum value for any data group within all existed data elements.
  The data group in the case of a histogram is the range of the X-axis arguments, and in the case of a bar chart, each individual data element.
  Considers only the categories filtered by the corresponding predicate.
  
  Specified by:
  
  getMaxGroupValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  categoryPredicate - filter for categories for which the maximum value is calculated
  
  Returns:
  
  the maximum value for any data group within all existed data elements
- getMaxValueByAnyCategory
  
  public double getMaxValueByAnyCategory()
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the maximum value for any category within all existed data elements.
  
  Specified by:
  
  getMaxValueByAnyCategory in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Returns:
  
  the maximum value for any category within all existed data elements
- getMaxValueByAnyCategory
  
  public double getMaxValueByAnyCategory(Predicate<C> categoryPredicate)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the maximum value between given filtered categories within all existed data elements.
  
  Specified by:
  
  getMaxValueByAnyCategory in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  categoryPredicate - filter for categories for which the maximum value is calculated
  
  Returns:
  
  the maximum value between given filtered categories within all existed data elements
- getValue
  
  public double getValue(T element, C category)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the value for given category within the given data element.
  
  Specified by:
  
  getValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the total value is being checked
  
  category - category for which the total value is being checked
  
  Returns:
  
  the value for given category within the given data element
- getSummaryValue
  
  public double getSummaryValue(T element)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the total value for all categories within the given data element.
  
  Specified by:
  
  getSummaryValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the total value is being checked
  
  Returns:
  
  the total value for all categories within the given date element
- getBarLabelColor
  
  public Color getBarLabelColor(T element)
  
  Description copied from class: BarLabeledVisualSet
  
  Returns the bar label color for given data element.
  
  Overrides:
  
  getBarLabelColor in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the bar label color is being checked
  
  Returns:
  
  the bar label color for given data element.
- getBarLabelFontSize
  
  public double getBarLabelFontSize(T element)
  
  Description copied from class: BarLabeledVisualSet
  
  Returns the bar label font size for given data element.
  
  Overrides:
  
  getBarLabelFontSize in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the bar label font size is being checked
  
  Returns:
  
  the bar label font size for given data element.
- getSummaryValue
  
  public double getSummaryValue(T element, Predicate<C> categoryPredicate)
  
  Description copied from interface: IAbstractBarVisualSet
  
  Returns the total value for specified categories within the specified data element.
  
  Specified by:
  
  getSummaryValue in interface IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  element - data element for which the total value is being checked
  
  categoryPredicate - filter for categories for which the amount is calculated
  
  Returns:
  
  the total value for specified categories within the specified data element
- setLabelText
  
  public HistogramVisualSet<T,C> setLabelText(LabelSide labelSide, BiFunction<T,C,String> labelText, BiFunction<T,C,Double> labelTextSize, BiFunction<T,C,Color> labelTextColor)
  
  Description copied from class: BarLabeledVisualSet
  
  Sets the labels of the bars representing plot data elements. The label of each bar is set independently of the labels on other sides of this bar or the labels on other bars. The label will not be displayed if the specified text is empty.
  
  Overrides:
  
  setLabelText in class BarLabeledVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Parameters:
  
  labelSide - the LabelSide of bar where the corresponding label will be drawn
  
  labelText - the text of the label
  
  labelTextSize - the font size of the label
  
  labelTextColor - the color of the label
  
  Returns:
  
  reference to this object
- addContextMenuHandler
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  contextMenuHandler - context menu call action
  
  Returns:
  
  reference to this object
- addMouseEnterHandler
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  handler - new mouse enter action
  
  Returns:
  
  reference to this object
- addMouseExitHandler
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  handler - new mouse exit action
  
  Returns:
  
  reference to this object
- addMousePressedHandler
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  handler - new mouse button pressed action
  
  Returns:
  
  reference to this object
- addVisibilityChangeHandler
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  visibilityChangeHandler - visibility change action
  
  Returns:
  
  reference to this object
- setMouseTransparent
  
  public HistogramVisualSet<T,C> 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  mouseTransparent - new value of property mouseTransparent
  
  Returns:
  
  reference to this object
- createVisualElement
  
  public HistogramVisualSet<T,C>.HistogramVisualElement 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 extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  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
- getVisualElements
  
  public List<HistogramVisualSet<T,C>.HistogramVisualElement> 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 IAbstractBarVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>
  
  Specified by:
  
  getVisualElements in interface IAbstractChartVisualSet
  
  Specified by:
  
  getVisualElements in interface IBarChartVisualSet
  
  Overrides:
  
  getVisualElements in class VisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup>
  
  Parameters:
  
  recalculationRequired - flag of the need to recalculate the visual elements
  
  Returns:
  
  the list of visual elements corresponding to current data elements

Class HistogramVisualSet<T extends HistogramDataAggregator<C,?>.HistogramDataGroup,C>

Nested Class Summary

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

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

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

HistogramVisualSet

HistogramVisualSet

HistogramVisualSet

HistogramVisualSet

Method Details

getExtractValuePolicy

getHistogramDataAggregator

getBiggestGroup

setColumnWidthFraction

getColumnWidthFraction

setElementText

setBarLabelText

setBarLabelColor

setBarLabelFontSize

getElementText

setLegendLabelText

setTooltipText

setBackgroundColor

setBorderColor

setBorderWidth

getMinArgument

getMaxArgument

getCategories

setUpdatePolicy

getBackgroundColor

getBorderColor

getBorderWidth

getLegendLabelText

getPercentOfMaxValue

getPercentOfMaxValue

getMaxGroupValue

getMaxGroupValue

getMaxValueByAnyCategory

getMaxValueByAnyCategory

getValue

getSummaryValue

getBarLabelColor

getBarLabelFontSize

getSummaryValue

setLabelText

addContextMenuHandler

addMouseEnterHandler

addMouseExitHandler

addMousePressedHandler

addVisibilityChangeHandler

setMouseTransparent

createVisualElement

getVisualElements