Enum AxisOption

  • All Implemented Interfaces:
    IPropCnrBoolean, java.io.Serializable, java.lang.Comparable<AxisOption>

    public enum AxisOption
    extends java.lang.Enum<AxisOption>
    implements IPropCnrBoolean
    The Axis2D boolean settings the can be set or retrieved.
    Author:
    Christopher Mindus
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DROP_LABELS
      Whether the axis automatically drops labels at regular interval or not to avoid labels overlapping.
      ENABLE_CACHE
      Whether the ticks and labels are cached from one rendering to another.
      FIXED
      Force all axis labels to be fixed numbers.
      HTML_LABELS
      Flag to use HTML (as opposed to the native vector graphics engine) to draw labels.
      INCLUDE_ZERO
      Option to include zero in axis, i.e.
      LABEL_SIZE_CHANGE
      Indicates to the axis whether the axis labels are changing their size on zoom.
      MAJOR_LABELS
      Flag to draw labels at major ticks.
      MICRO_TICKS
      Flag to draw micro ticks on an axis.
      MINOR_LABELS
      Flag to labels on minor ticks when there is enough space.
      MINOR_TICKS
      Flag to draw minor ticks on an axis.
      NATURAL
      Ensure tick marks are made on "natural" numbers.
      VERTICAL
      The Axis direction as vertical (true), horizontal (false) is default.
      VISIBLE
      Provides support for an invisible axis, i.e.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean getDefaultValue()
      Gets the default value when the property is not set.
      java.lang.String getPropName()
      Returns the name of the property, usually starting with '$'.
      static AxisOption valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static AxisOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • VERTICAL

        public static final AxisOption VERTICAL
        The Axis direction as vertical (true), horizontal (false) is default.

        Default is false, i.e. horizontal.

      • VISIBLE

        public static final AxisOption VISIBLE
        Provides support for an invisible axis, i.e. the axis visible setting.

        Default is true.

      • INCLUDE_ZERO

        public static final AxisOption INCLUDE_ZERO
        Option to include zero in axis, i.e. will make the lower bound be zero instead of the lowest value. If the lowest data value is negative the "includeZero" option has no effect.

        Default is false.

      • FIXED

        public static final AxisOption FIXED
        Force all axis labels to be fixed numbers.

        Default is true.

      • NATURAL

        public static final AxisOption NATURAL
        Ensure tick marks are made on "natural" numbers.

        Defaults to false.

      • MAJOR_LABELS

        public static final AxisOption MAJOR_LABELS
        Flag to draw labels at major ticks.

        Default is true.

      • MINOR_TICKS

        public static final AxisOption MINOR_TICKS
        Flag to draw minor ticks on an axis.

        Default is true.

      • MINOR_LABELS

        public static final AxisOption MINOR_LABELS
        Flag to labels on minor ticks when there is enough space.

        Default is true.

      • MICRO_TICKS

        public static final AxisOption MICRO_TICKS
        Flag to draw micro ticks on an axis.

        Default is false.

      • HTML_LABELS

        public static final AxisOption HTML_LABELS
        Flag to use HTML (as opposed to the native vector graphics engine) to draw labels.

        Default is true.

      • DROP_LABELS

        public static final AxisOption DROP_LABELS
        Whether the axis automatically drops labels at regular interval or not to avoid labels overlapping. This gives better results but require more computations. You can disable it to save computation time when you know your labels won't overlap.

        Default is true.

      • LABEL_SIZE_CHANGE

        public static final AxisOption LABEL_SIZE_CHANGE
        Indicates to the axis whether the axis labels are changing their size on zoom. If false this allows to optimize the axis by avoiding recomputing labels maximum size on zoom actions.

        Default is false.

      • ENABLE_CACHE

        public static final AxisOption ENABLE_CACHE
        Whether the ticks and labels are cached from one rendering to another. This improves the rendering performance of successive rendering but penalize the first rendering. For labels it is only working with GFX labels not HTML ones.

        Default false.

    • Method Detail

      • values

        public static AxisOption[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AxisOption c : AxisOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AxisOption valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getDefaultValue

        public boolean getDefaultValue()
        Gets the default value when the property is not set.
        Specified by:
        getDefaultValue in interface IPropCnrBoolean
      • getPropName

        public java.lang.String getPropName()
        Returns the name of the property, usually starting with '$'.
        Specified by:
        getPropName in interface IPropCnrBoolean