Package uk.ac.starlink.ttools.plot2.geom

Class TimeSurfaceFactory.Profile

java.lang.Object
uk.ac.starlink.ttools.plot2.geom.TimeSurfaceFactory.Profile
Enclosing class:
TimeSurfaceFactory
public static class TimeSurfaceFactory.Profile extends Object
Profile class which defines fixed configuration items for a TimeSurface. Instances of this class are usually obtained from the createProfile method.

  • Constructor Details

    • Profile

      public Profile(boolean ylog, boolean yflip, String tlabel, String ylabel, Captioner captioner, boolean grid, double tcrowd, double ycrowd, TimeFormat tformat, boolean minor, boolean tannotate)
      Constructor.
      Parameters:
      ylog - whether to use logarithmic scaling on Y axis
      yflip - whether to invert direction of Y axis
      tlabel - text for labelling time axis
      ylabel - text for labelling Y axis
      captioner - text renderer for axis labels etc
      grid - whether to draw grid lines
      tcrowd - crowding factor for tick marks on time axis; 1 is normal
      ycrowd - crowding factor for tick marks on Y axis; 1 is normal
      tformat - time labelling format
      minor - whether to draw minor ticks
      tannotate - whether to annotate time axis

  • Method Details

    • getYLog

      public boolean getYLog()
      Indicates whether Y axis is logarithmic.
      Returns:
      true for Y logarithmic scaling, false for linear

    • fixTimeAnnotation

      public TimeSurfaceFactory.Profile fixTimeAnnotation(boolean tannotate)
      Returns a new profile instance the same as this one, except that the flag for whether to annotate the time axis may be set.
      Parameters:
      tannotate - whether to annotate time axis