Class SkyAxisLabellers


  • public class SkyAxisLabellers
    extends java.lang.Object
    Implementation class containing SkyAxisLabeller implementations.
    Since:
    21 Feb 2013
    Author:
    Mark Taylor
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static SkyAxisLabeller EXTERNAL
      Labeller implementation that draws labels outside the plot bounds.
      static SkyAxisLabeller HYBRID
      Labeller implementation that draws labels outside the plot bounds unless they don't appear, in which case it draws them inside.
      static SkyAxisLabeller INTERNAL
      Labeller implementation that draws labels inside the plot bounds.
      static SkyAxisLabeller LAME
      Basic labeller implementation.
      static SkyAxisLabeller NONE
      Labeller implentation that does no drawing.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SkyAxisLabeller getAutoLabeller​(boolean skyFillsBounds)
      Returns the axis mode to use if choosing one automatically based on plot characteristics.
      static SkyAxisLabeller[] getKnownLabellers()
      Returns a list of the known SkyAxisLabeller instances.
      static Caption labelCaption​(java.lang.String label)
      Turns a sky grid line label into a Caption.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • NONE

        public static SkyAxisLabeller NONE
        Labeller implentation that does no drawing.
      • LAME

        public static SkyAxisLabeller LAME
        Basic labeller implementation. Grid lines are drawn OK, but not much effort is made to position axis labels sensibly.
      • EXTERNAL

        public static SkyAxisLabeller EXTERNAL
        Labeller implementation that draws labels outside the plot bounds.
      • INTERNAL

        public static SkyAxisLabeller INTERNAL
        Labeller implementation that draws labels inside the plot bounds.
      • HYBRID

        public static SkyAxisLabeller HYBRID
        Labeller implementation that draws labels outside the plot bounds unless they don't appear, in which case it draws them inside. Doesn't necessarily end up looking as sensible as it sounds.
    • Method Detail

      • labelCaption

        public static Caption labelCaption​(java.lang.String label)
        Turns a sky grid line label into a Caption. Some manipulation of the text for better LaTeX rendering is done.
        Parameters:
        label - grid line label
        Returns:
        caption object
      • getKnownLabellers

        public static SkyAxisLabeller[] getKnownLabellers()
        Returns a list of the known SkyAxisLabeller instances. The first element is null, which is interpreted as auto mode.
        Returns:
        list of sky axis labellers
      • getAutoLabeller

        public static SkyAxisLabeller getAutoLabeller​(boolean skyFillsBounds)
        Returns the axis mode to use if choosing one automatically based on plot characteristics.
        Parameters:
        skyFillsBounds - true if the sky region of the plane fills all or most of the plotting region; false if there are significant non-sky parts
        Returns:
        suitable axis labeller