Package io.deephaven.plot

Interface Axis

All Superinterfaces:
Serializable
All Known Subinterfaces:
Figure
All Known Implementing Classes:
AxisImpl, FigureImpl, FigureWidget, ScatterPlotMatrix
public interface Axis extends Serializable
Represents an axis.

  • Method Details

    • axisFormat

      Axis axisFormat(AxisFormat axisFormat)
      Sets the AxisFormat for this Axis.
      Parameters:
      axisFormat - axis format
      Returns:
      this Axis

    • axisFormatPattern

      Axis axisFormatPattern(String axisFormatPattern)
      Sets the format pattern for this Axis's labels.
      Parameters:
      axisFormatPattern - axis format pattern
      Returns:
      this Axis

    • axisColor

      Axis axisColor(Paint color)
      Sets the color for this Axis line and tick marks.
      Parameters:
      color - color
      Returns:
      this Axis

    • axisColor

      Axis axisColor(String color)
      Sets the color for this Axis line and tick marks.
      Parameters:
      color - color
      Returns:
      this Axis

    • axisLabel

      Axis axisLabel(String label)
      Sets the label for this Axis.
      Parameters:
      label - label
      Returns:
      this Axis

    • axisLabelFont

      Axis axisLabelFont(Font font)
      Sets the font for this Axis's label.
      Parameters:
      font - font
      Returns:
      this Axis

    • axisLabelFont

      Axis axisLabelFont(String family, String style, int size)
      Sets the font for this Axis's label.
      Parameters:
      family - font family; if null, set to Arial
      style - font style; if null, set to Font.FontStyle PLAIN
      size - the point size of the Font
      Returns:
      this Axis

    • ticksFont

      Axis ticksFont(Font font)
      Sets the font for this Axis's ticks.
      Parameters:
      font - font
      Returns:
      this Axis

    • ticksFont

      Axis ticksFont(String family, String style, int size)
      Sets the font for this Axis's ticks.
      Parameters:
      family - font family; if null, set to Arial
      style - font style; if null, set to Font.FontStyle PLAIN
      size - the point size of the Font
      Returns:
      this Axis

    • transform

      Axis transform(AxisTransform transform)
      Sets the AxisTransform for this Axis.
      Parameters:
      transform - transform
      Returns:
      this Axis

    • log

      Axis log()
      Sets the AxisTransform as log base 10.
      Returns:
      this Axis

    • log

      Axis log(boolean useLog)
      Sets the AxisTransform as log base 10.
      Parameters:
      useLog - true to use a log axis transform; false to use a linear axis transform.
      Returns:
      this Axis

    • businessTime

      Axis businessTime(BusinessCalendar calendar)
      Sets this Axis's AxisTransform as an AxisTransformBusinessCalendar.
      Parameters:
      calendar - business calendar of the AxisTransformBusinessCalendar
      Returns:
      this Axis using the specified business calendar.

    • businessTime

      Axis businessTime(SelectableDataSet sds, String calendar)
      Sets this Axis's AxisTransform as an AxisTransformBusinessCalendar.
      Parameters:
      sds - selectable data set (e.g. OneClick filterable table) containing the business calendar.
      calendar - name of a column containing String values, where each value is the name of a BusinessCalendar.
      Returns:
      this Axis using the business calendar from row 0 of the filtered sds for the business calendar. If no value is found, no transform will be applied.

    • businessTime

      Axis businessTime()
      Sets this Axis's AxisTransform as an AxisTransformBusinessCalendar.
      Returns:
      this Axis using the default business calendar.

    • businessTime

      Axis businessTime(boolean useBusinessTime)
      Sets this Axis's AxisTransform as an AxisTransformBusinessCalendar.
      Parameters:
      useBusinessTime - true to use a business time axis transform; false to use a linear axis transform.
      Returns:
      this Axis using the default business calendar or this Axis using a linear axis transform.

    • invert

      Axis invert()
      Inverts this Axis so that larger values are closer to the origin.
      Returns:
      this Axes

    • invert

      Axis invert(boolean invert)
      Inverts this Axis so that larger values are closer to the origin.
      Parameters:
      invert - if true, larger values will be closer to the origin; otherwise, smaller values will be closer to the origin.
      Returns:
      this Axes

    • range

      Axis range(double min, double max)
      Sets the range of this Axis to [min, max] inclusive.
      Parameters:
      min - minimum of the range
      max - maximum of the range
      Returns:
      this Axis

    • min

      Axis min(double min)
      Sets the minimum range of this Axis.
      Parameters:
      min - minimum of the range
      Returns:
      this Axis

    • max

      Axis max(double max)
      Sets the maximum range of this Axis.
      Parameters:
      max - maximum of the range
      Returns:
      this Axis

    • min

      Axis min(SelectableDataSet sds, String min)
      Sets the minimum range of this Axis.
      Parameters:
      sds - selectable dataset
      min - column in sds, where the minimum value is stored in row 0.
      Returns:
      this Axes

    • max

      Axis max(SelectableDataSet sds, String max)
      Sets the maximum range of this Axis.
      Parameters:
      sds - selectable dataset
      max - column in sds, where the maximum value is stored in row 0.
      Returns:
      this Axes

    • ticksVisible

      Axis ticksVisible(boolean visible)
      Sets whether ticks are drawn on this Axis.
      Parameters:
      visible - whether ticks are drawn on this Axis
      Returns:
      this Axis

    • ticks

      Axis ticks(double gapBetweenTicks)
      Sets the tick locations.
      Parameters:
      gapBetweenTicks - the distance between ticks. For example, if gapBetweenTicks is 5.0, and the first tick is at 10.0, the next will be drawn at 15.0.
      Returns:
      this Axis

    • ticks

      Axis ticks(double[] tickLocations)
      Sets the tick locations.
      Parameters:
      tickLocations - coordinates of the major tick locations
      Returns:
      this Axis

    • minorTicksVisible

      Axis minorTicksVisible(boolean visible)
      Sets whether minor ticks are drawn on this Axis.
      Parameters:
      visible - whether minor ticks are drawn on this Axis
      Returns:
      this Axis

    • minorTicks

      Axis minorTicks(int nminor)
      Sets the number of minor ticks between consecutive major ticks. These minor ticks are equally spaced.
      Parameters:
      nminor - number of minor ticks between consecutive major ticks.
      Returns:
      this Axis

    • tickLabelAngle

      Axis tickLabelAngle(double angle)
      Sets the angle the tick labels of this Axis are drawn at.
      Parameters:
      angle - angle in degrees
      Returns:
      this Axis