Package com.amalgamasimulation.charts.axes

Interface ISetNumericDisplayedRangePropertyOwner

All Superinterfaces:
ICurrentValuePropertyOwner, IGetDisplayedRangePropertyOwner
All Known Subinterfaces:
ISetTimeDisplayedRangePropertyOwner
All Known Implementing Classes:
GanttChartNumericXAxis, GanttChartTimeXAxis, LineChartNumericXAxis, LineChartTimeXAxis
public interface ISetNumericDisplayedRangePropertyOwner extends IGetDisplayedRangePropertyOwner, ICurrentValuePropertyOwner
Interface of displayed range property owners. Provides a set of methods corresponding to it.
Author:
Aleksey Kirillov

  • Method Details

    • setDisplayedRangeMinSize

      ISetNumericDisplayedRangePropertyOwner setDisplayedRangeMinSize(double minSize)
      Sets the minimum size of displayed values range of axis. 0 by default. This size limits the users' ability to scale the range of axis down.
      Parameters:
      minSize - new minimum size of displayed values range of axis
      Returns:
      reference to this object

    • setDisplayedRangeMaxSize

      ISetNumericDisplayedRangePropertyOwner setDisplayedRangeMaxSize(double maxSize)
      Sets the maximum size of displayed values range of axis. Maximum is not limited by default. This size limits the users' ability to scale the range of axis up.
      Parameters:
      maxSize - new maximum size of displayed values range of axis
      Returns:
      reference to this object

    • getDisplayedRangeMinSize

      double getDisplayedRangeMinSize()
      Returns the minimum size of displayed values range of axis.
      Returns:
      the minimum size of displayed values range of axis

    • getDisplayedRangeMaxSize

      double getDisplayedRangeMaxSize()
      Returns the maximum size of displayed values range of axis.
      Returns:
      the maximum size of displayed values range of axis

    • setDisplayedRangeChangeEnabled

      ISetNumericDisplayedRangePropertyOwner setDisplayedRangeChangeEnabled()
      Specifies the displayed values range can be changed.
      Returns:
      reference to this object

    • setDisplayedRangeChangeDisabled

      ISetNumericDisplayedRangePropertyOwner setDisplayedRangeChangeDisabled(double displayedRangeSize)
      Specifies the displayed values range cannot be changed. Displayed values range becomes equals to displayedRangeSize.
      Parameters:
      displayedRangeSize - new fixed displayed range size
      Returns:
      reference to this object

    • isDisplayedRangeChangeEnabled

      boolean isDisplayedRangeChangeEnabled()
      Checks whether the displayed values range can be changed.
      Returns:
      true if the displayed values range can be changed, false otherwise

    • setDisplayedRange

      ISetNumericDisplayedRangePropertyOwner setDisplayedRange(double minValue, double maxValue)
      Sets the currently displayed values range of axis. Scrolls and scales the axis accordingly and redraws the chart.
      Parameters:
      minValue - new displayed range minimum value
      maxValue - new displayed range maximum value
      Returns:
      reference to this object
      See Also:

    • adjustDisplayRange

      ISetNumericDisplayedRangePropertyOwner adjustDisplayRange(boolean adjustToFirstNonZeroElement)
      Sets the minimum and maximum displayed values equal to the minimum and maximum values in the chart contents. Used to display a complete set of data within a single displayed range.
      Parameters:
      adjustToFirstNonZeroElement - specifies the 'left adjustment' option
      Returns:
      reference to this object

    • setDisplayedRangeToDefault

      ISetNumericDisplayedRangePropertyOwner setDisplayedRangeToDefault()
      Resets displayed range to default values. The default state is the range of data items, including the last one i.e. with zero scroll.
      Returns:
      reference to this object