Enum Class AxisOption

java.lang.Object
java.lang.Enum<AxisOption>
com.iizix.prop.ui.chart.axis2d.AxisOption
All Implemented Interfaces:
IPropCnrBoolean, Serializable, Comparable<AxisOption>, Constable

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

    Nested classes/interfaces inherited from class Enum

    Enum.EnumDesc<E>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Whether the axis automatically drops labels at regular interval or not to avoid labels overlapping.
    Whether the ticks and labels are cached from one rendering to another.
    Force all axis labels to be fixed numbers.
    Flag to use HTML (as opposed to the native vector graphics engine) to draw labels.
    Option to include zero in axis, i.e.
    Indicates to the axis whether the axis labels are changing their size on zoom.
    Flag to draw labels at major ticks.
    Flag to draw micro ticks on an axis.
    Flag to labels on minor ticks when there is enough space.
    Flag to draw minor ticks on an axis.
    Ensure tick marks are made on "natural" numbers.
    Nice ticks: the major tick step is chosen from the axis range at every rendering, 1, 2 or 5 times a power of ten giving four to eight intervals (for time labels: 1 to 30 minutes, 1 to 12 hours or a day), so a live chart whose range grows keeps labelled ticks; dojox alone takes the power of ten below the range, which leaves a range of 10 to 19 with two ticks and no labels between them (CC-FIX-DASHBOARD-CHARTS).
    Time labels: the axis values are seconds since the Epoch and every label is the clock time of its value, "HH:mm", in the client's time zone (CC-FIX-DASHBOARD-CHARTS).
    The Axis direction as vertical (true), horizontal (false) is default.
    Provides support for an invisible axis, i.e.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Gets the default value when the property is not set.
    Returns the name of the property, usually starting with '$'.
    static AxisOption
    Returns the enum constant of this class with the specified name.
    static AxisOption[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class Object

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

    • 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.

    • TIME_LABELS

      public static final AxisOption TIME_LABELS
      Time labels: the axis values are seconds since the Epoch and every label is the clock time of its value, "HH:mm", in the client's time zone (CC-FIX-DASHBOARD-CHARTS). Use it with NICE_TICKS, which then places the ticks on round clock times.

      Default false.

    • NICE_TICKS

      public static final AxisOption NICE_TICKS
      Nice ticks: the major tick step is chosen from the axis range at every rendering, 1, 2 or 5 times a power of ten giving four to eight intervals (for time labels: 1 to 30 minutes, 1 to 12 hours or a day), so a live chart whose range grows keeps labelled ticks; dojox alone takes the power of ten below the range, which leaves a range of 10 to 19 with two ticks and no labels between them (CC-FIX-DASHBOARD-CHARTS). A $majorTickStep that is set wins.

      Default false.

  • Method Details

    • values

      public static AxisOption[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static AxisOption valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      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 String getPropName()
      Returns the name of the property, usually starting with '$'.
      Specified by:
      getPropName in interface IPropCnrBoolean