Package com.amalgamasimulation.charts

Class HeatmapChart

java.lang.Object
com.amalgamasimulation.charts.Chart<IHeatmapChartVisualSet,HeatmapVisualSetContainer>
com.amalgamasimulation.charts.HeatmapChart
public class HeatmapChart extends Chart<IHeatmapChartVisualSet,HeatmapVisualSetContainer>
A heatmap chart is a specialized chart that uses colors to represent data values in a table. This chart is typically used to show how some indicator changes with change of two independent variables. For example, the chart can show how service level in a supply chain changes with increase of storage capacity and forecasting accuracy.

A chart is a GUI component based on JavaFX's XYChart class that can be used to conveniently draw numeric and statistical data. All charts are designed to be compatible with Eclipse RCP applications and SWT framework.

Author:
Aleksey Kirillov

  • Field Details

    • internalHeatmapChart

      protected com.amalgamasimulation.charts.internals.charts.HeatmapChartInternal internalHeatmapChart

    • xAxis

      protected HeatmapChartXAxis xAxis

    • yAxis

      protected HeatmapChartYAxis yAxis

  • Constructor Details

    • HeatmapChart

      public HeatmapChart(IChartEnvironment chartEnvironment)
      Constructs a Heatmap Chart with no title.
      Parameters:
      chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart

    • HeatmapChart

      public HeatmapChart(IChartEnvironment chartEnvironment, String title)
      Constructs a Heatmap Chart with a given title.
      Parameters:
      chartEnvironment - parent subtype of IChartEnvironment, that is a layer between the parent composite and this chart
      title - chart title i.e. label written above the chart

  • Method Details

    • getChartInternal

      protected final com.amalgamasimulation.charts.internals.charts.HeatmapChartInternal getChartInternal()
      Specified by:
      getChartInternal in class Chart<IHeatmapChartVisualSet,HeatmapVisualSetContainer>

    • getXAxis

      public HeatmapChartXAxis getXAxis()
      Description copied from class: Chart
      Returns the X-axis of this chart.
      Specified by:
      getXAxis in class Chart<IHeatmapChartVisualSet,HeatmapVisualSetContainer>
      Returns:
      the X-axis of this chart

    • getYAxis

      public HeatmapChartYAxis getYAxis()
      Description copied from class: Chart
      Returns the Y-axis of this chart.
      Specified by:
      getYAxis in class Chart<IHeatmapChartVisualSet,HeatmapVisualSetContainer>
      Returns:
      the Y-axis of this chart

    • addContextMenuItem

      public HeatmapChart addContextMenuItem(HeatmapChartContextMenuItem contextMenuItem)
      Adds the new context menu item to the end of the items list.
      Parameters:
      contextMenuItem - new context menu item
      Returns:
      reference to this object

    • removeContextMenuItem

      public HeatmapChart removeContextMenuItem(HeatmapChartContextMenuItem contextMenuHandler)
      Removes the context menu item.
      Parameters:
      contextMenuHandler - removed context menu item
      Returns:
      reference to this object

    • clearContextMenuItems

      public HeatmapChart clearContextMenuItems()
      Removes all context menu items added by the 'addContextMenuItem' calls. Does not affect pre-installed items such as 'copy to clipboard'.
      Returns:
      reference to this object

    • setShowYAxisCategoryMenuItemVisible

      public HeatmapChart setShowYAxisCategoryMenuItemVisible(boolean visible)
      Adds a context menu element that controls the search and navigation for elements of the Y-axis.
      Parameters:
      visible - new visibility of the menu element 'search and navigation'
      Returns:
      reference to this object

    • setShowXAxisCategoryMenuItemVisible

      public HeatmapChart setShowXAxisCategoryMenuItemVisible(boolean visible)
      Adds a context menu element that controls the search and navigation for elements of the X-axis.
      Parameters:
      visible - new visibility of the menu element 'search and navigation'
      Returns:
      reference to this object

    • addMouseClickHandler

      public HeatmapChart addMouseClickHandler(Consumer<HeatmapChartMouseClickDescriptor> handler)
      Adds the action to be executed every time the contents area is clicked.
      Parameters:
      handler - new contents area click action
      Returns:
      reference to this object

    • removeMouseClickHandler

      public HeatmapChart removeMouseClickHandler(Consumer<HeatmapChartMouseClickDescriptor> handler)
      Removes the contents area click action.
      Parameters:
      handler - removed contents area click action
      Returns:
      reference to this object

    • clearMouseClickHandlers

      public HeatmapChart clearMouseClickHandlers()
      Removes all the contents area click actions.
      Returns:
      reference to this object