Package com.amalgamasimulation.charts

Interface IVerticalGuidelineOwner<VS extends IAbstractChartVisualSet,VSC extends AbstractVisualSetContainer<VS>>

All Known Implementing Classes:
AbstractBarChart, AbstractGanttChart, AbstractLineChart, BarChart, HistogramChart, NumericGanttChart, NumericLineChart, TimeGanttChart, TimeLineChart
public interface IVerticalGuidelineOwner<VS extends IAbstractChartVisualSet,VSC extends AbstractVisualSetContainer<VS>>
Interface of vertical guideline property owners. Provides a set of methods corresponding to it.
Author:
Aleksey Kirillov

  • Method Details

    • setVerticalGuidelineVisible

      Chart<VS,VSC> setVerticalGuidelineVisible(boolean visible)
      Specifies whether the vertical guideline functionality should be enabled for the end users of this chart. This functionality allows the users to show and hide the vertical guideline by clicking on the chart contents area. Redraws this chart if visibility is changed.

      Vertical guideline functionality is enabled by default.

      Parameters:
      visible - true if vertical guideline functionality should be enabled, false otherwise
      Returns:
      reference to this object

    • setVerticalGuidelineLabelVisible

      Chart<VS,VSC> setVerticalGuidelineLabelVisible(boolean visible)
      Specifies whether the vertical guideline label should be drawn. Is true by default. Redraws this chart if visibility is changed.
      Parameters:
      visible - new vertical guideline label visibility
      Returns:
      reference to this object

    • setVerticalGuidelineValuesVisible

      Chart<VS,VSC> setVerticalGuidelineValuesVisible(boolean visible)
      Specifies whether the legend values of the applicable visual sets should be drawn when a vertical guideline is shown. The displayed values are the result of the intersection of the corresponding data elements with a vertical guideline. Is true by default. Redraws this chart if visibility is changed.
      Parameters:
      visible - true if the legend values should be drawn, false otherwise
      Returns:
      reference to this object

    • showVerticalGuidelineDisplayed

      Chart<VS,VSC> showVerticalGuidelineDisplayed(double position)
      Shows a vertical guideline at the specified X-axis position. Redraws this chart.
      Parameters:
      position - specified X-axis position of the vertical guideline
      Returns:
      reference to this object

    • setVerticalGuidelineColor

      Chart<VS,VSC> setVerticalGuidelineColor(Color color)
      Sets the new color to the vertical guideline. Redraws this chart if color is changed.
      Parameters:
      color - new vertical guideline color
      Returns:
      reference to this object

    • setVerticalGuidelineColor

      Chart<VS,VSC> setVerticalGuidelineColor(javafx.scene.paint.Color color)
      Sets the new color to the vertical guideline. Redraws this chart if color is changed.
      Parameters:
      color - new vertical guideline color
      Returns:
      reference to this object

    • setVerticalGuidelineWidth

      Chart<VS,VSC> setVerticalGuidelineWidth(double width)
      Sets the new width to the vertical guideline, in pixels. Redraws this chart if width is changed.
      Parameters:
      width - new vertical guideline width, in pixels
      Returns:
      reference to this object

    • isVerticalGuidelineVisible

      boolean isVerticalGuidelineVisible()
      Checks whether vertical guideline is drawn.
      Returns:
      true if vertical guideline is drawn, false otherwise

    • isVerticalGuidelineLabelVisible

      boolean isVerticalGuidelineLabelVisible()
      Checks whether the vertical guideline label is drawn.
      Returns:
      true if the vertical guideline label is drawn, false otherwise

    • isVerticalGuidelineValuesVisible

      boolean isVerticalGuidelineValuesVisible()
      Checks whether the legend values are drawn.
      Returns:
      true if the legend values are drawn, false otherwise

    • getVerticalGuidelineColor

      javafx.scene.paint.Color getVerticalGuidelineColor()
      Returns the current color of the vertical guideline.
      Returns:
      the current color of the vertical guideline

    • getVerticalGuidelineWidth

      double getVerticalGuidelineWidth()
      Returns the current width of the vertical guideline.
      Returns:
      the current width of the vertical guideline

    • hideVerticalGuideline

      Chart<VS,VSC> hideVerticalGuideline()
      Hides the currently displayed vertical guideline. Redraws this chart. Does nothing if the vertical guideline is not currently displayed.
      Returns:
      reference to this object

    • isVerticalGuidelineDisplayed

      boolean isVerticalGuidelineDisplayed()
      Checks whether vertical guideline is displayed.
      Returns:
      true if vertical guideline is displayed

    • getVerticalGuidelinePosition

      double getVerticalGuidelinePosition()
      Returns the current X-axis position of vertical guideline.
      Returns:
      the current X-axis position of vertical guideline

    • addVerticalGuidelineChangeHandler

      void addVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)
      Adds the action to be executed every time the vertical guideline visibility or position is changed.
      Parameters:
      handler - new action to be executed every time the vertical guideline visibility or position is changed

    • removeVerticalGuidelineChangeHandler

      void removeVerticalGuidelineChangeHandler(BiConsumer<Boolean,Double> handler)
      Removes the vertical guideline visibility or position changed action.
      Parameters:
      handler - removed vertical guideline visibility or position changed action

    • clearVerticalGuidelineChangeHandlers

      void clearVerticalGuidelineChangeHandlers()
      Clear all the vertical guideline visibility or position changed actions.

    • setVerticalGuidelineSnapToGridLines

      Chart<VS,VSC> setVerticalGuidelineSnapToGridLines(boolean snapToGridLines)
      Specifies whether the vertical guideline should be snapped to grid lines.
      Parameters:
      snapToGridLines - new value of property vertical guideline snapped to grid lines
      Returns:
      reference to this object

    • isVerticalGuidelineSnapToGridLines

      boolean isVerticalGuidelineSnapToGridLines()
      Checks whether vertical guideline is snapped to grid lines.
      Returns:
      true if vertical guideline is snapped to grid lines