Package com.amalgamasimulation.charts.visualsets.types

Interface IAbstractChartVisualSet

All Known Subinterfaces:
IBarChartVisualSet, IGanttChartVisualSet, IHeatmapChartVisualSet, ILineChartVisualSet
All Known Implementing Classes:
AbstractGridLineVisualSet, AbstractLineVisualSet, AbstractPolylineVisualSet, AbstractRegionVisualSet, BarLabeledVisualSet, BarVisualSet, BoxAndWhiskerVisualSet, ConnectionVisualSet, GanttPolylineVisualSet, GanttVisualSet, HeatmapVisualSet, HistogramVisualSet, HorizontalGridLineVisualSet, LabeledVisualSet, LineBarVisualSet, LineVisualSet, PointsVisualSet, PolylineVisualSet, RangeRegionVisualSet, RegionVisualSet, SlotsVisualSet, TriangleMarkerVisualSet, VerticalGridLineVisualSet, VisualSet, WaterfallVisualSet
public interface IAbstractChartVisualSet
Interface implemented by VisualSets that can be displayed on any subclass of a Chart.
Author:
Aleksey Kirillov

  • Method Details

    • getContents

      List<?> getContents()
      Returns the list of visual set contents.
      Returns:
      the list of visual set contents

    • getName

      String getName()
      Returns visual set name i.e. the String is used to sort and name the visual sets on the chart.
      Returns:
      visual set name

    • getVisibleVisualElementsCount

      int getVisibleVisualElementsCount(double beginArgument, double endArgument)
      Returns the number of VisualElements drawn within the bounds of the specified begin and end X-axis arguments.
      Parameters:
      beginArgument - begin bounds X-axis argument
      endArgument - end bounds X-axis argument
      Returns:
      the number of VisualElements drawn within the bounds of the specified begin and end X-axis arguments

    • addVisibilityChangeHandler

      IAbstractChartVisualSet addVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> handler)
      Adds the action to be executed every time the visibility of this VisualSet is changed.
      Parameters:
      handler - visibility change action
      Returns:
      reference to this object

    • removeVisibilityChangeHandler

      IAbstractChartVisualSet removeVisibilityChangeHandler(Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>> handler)
      Removes the action to be executed every time the visibility of this VisualSet is changed.
      Parameters:
      handler - visibility change action
      Returns:
      reference to this object

    • getVisibilityChangeHandlers

      List<Consumer<VisibilityChangeDescriptor<? extends IAbstractChartVisualSet>>> getVisibilityChangeHandlers()
      Return the list of the actions to be executed every time the visibility of this VisualSet is changed.
      Returns:
      the list of the actions to be executed every time the visibility of this VisualSet is changed

    • getMinArgument

      double getMinArgument()
      Returns the minimum possible value that stored in the current data elements list.
      Returns:
      the minimum possible value that stored in the current data elements list

    • getMaxArgument

      double getMaxArgument()
      Returns the maximum possible value that stored in the current data elements list.
      Returns:
      the maximum possible value that stored in the current data elements list

    • getVisualElements

      List<? extends IAbstractChartVisualElement<?>> getVisualElements(boolean recalculationRequired)
      Returns the list of visual elements corresponding to current data elements. Cannot be changed by the user.
      Parameters:
      recalculationRequired - flag of the need to recalculate the visual elements
      Returns:
      the list of visual elements corresponding to current data elements

    • addVisualSetChangeHandler

      void addVisualSetChangeHandler(IVisualSetListener handler)
      Adds the action to be executed every time the elements list of this VisualSet is changed.
      Parameters:
      handler - visibility change action

    • removeVisualSetChangeHandler

      void removeVisualSetChangeHandler(IVisualSetListener handler)
      Removes the action to be executed every time the elements list of this VisualSet is changed.
      Parameters:
      handler - visibility change action

    • getUpdatePolicy

      VisualSet.UpdatePolicy getUpdatePolicy()
      Return the current VisualSet.UpdatePolicy.
      Returns:
      the current VisualSet.UpdatePolicy

    • setUpdatePolicy

      IUpdatePolicyPropertyOwner setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)
      Sets the new VisualSet.UpdatePolicy i.e. the VisualSet update control rule.
      Parameters:
      updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule
      Returns:
      reference to this object

    • isMouseTransparent

      boolean isMouseTransparent()
      Returns 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.
      Returns:
      the value of the property mouseTransparent

    • setMouseTransparent

      IAbstractChartVisualSet setMouseTransparent(boolean mouseTransparent)
      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.
      Parameters:
      mouseTransparent - new value of property mouseTransparent
      Returns:
      reference to this object