Package com.iizix.prop.ui.chart.plot2d

Enum Class PlotOption

java.lang.Object
java.lang.Enum<PlotOption>
com.iizix.prop.ui.chart.plot2d.PlotOption
All Implemented Interfaces:
IPropCnrBoolean, Serializable, Comparable<PlotOption>, Constable
public enum PlotOption extends Enum<PlotOption> implements IPropCnrBoolean
The Plot2D boolean settings the can be set or retrieved.
Author:
Christopher Mindus

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AREAS
    Whether or not to draw areas on this plot.
    ENABLE_CACHE
    Whether the markers are cached from one rendering to another.
    FIXED
    Whether a fixed precision must be applied to data values for display.
    H_MAJOR_LINES
    Grid option whether to show lines at the major ticks along the horizontal axis.
    H_MINOR_LINES
    Grid option whether to show lines at the minor ticks along the horizontal axis.
    H_STRIPES
    Grid option whether to show horizontal stripes.
    HTML_LABELS
    Whether or not to use HTML to render labels.
    INTERPOLATE
    Whether when there is a null data point in the data the plot interpolates it or if the lines is split at that point.
    LABELS
    Whether or not to draw labels on this plot.
    LINES
    Whether or not to draw lines on this plot.
    MARKERS
    Whether or not to draw markers at data points on this plot.
    OMIT_LABELS
    Whether labels of slices small to the point of not being visible are omitted.
    RENDER_ON_AXIS
    Grid option whether or not the grid is rendered when drawn at horizontal or vertical axis position.
    TICKS
    Whether or not to draw lines on this plot.
    V_MAJOR_LINES
    Grid option whether to show lines at the major ticks along the vertical axis.
    V_MINOR_LINES
    Grid option whether to show lines at the major ticks along the vertical axis.
    V_STRIPES
    Grid option whether to show vertical stripes.

  • Method Summary

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

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • LABELS

      public static final PlotOption LABELS
      Whether or not to draw labels on this plot.

      Defaults to true.

    • HTML_LABELS

      public static final PlotOption HTML_LABELS
      Whether or not to use HTML to render labels.

      Defaults to true.

    • OMIT_LABELS

      public static final PlotOption OMIT_LABELS
      Whether labels of slices small to the point of not being visible are omitted.

      Default false.

    • TICKS

      public static final PlotOption TICKS
      Whether or not to draw lines on this plot.

      Default varies depending on the plot.

    • LINES

      public static final PlotOption LINES
      Whether or not to draw lines on this plot.

      Defaults to true.

    • AREAS

      public static final PlotOption AREAS
      Whether or not to draw areas on this plot.

      Defaults to false.

    • MARKERS

      public static final PlotOption MARKERS
      Whether or not to draw markers at data points on this plot.

      Default is false.

    • FIXED

      public static final PlotOption FIXED
      Whether a fixed precision must be applied to data values for display.

      Default is true.

    • ENABLE_CACHE

      public static final PlotOption ENABLE_CACHE
      Whether the markers are cached from one rendering to another. This improves the rendering performance of successive rendering but penalize the first rendering.

      Default false.

    • INTERPOLATE

      public static final PlotOption INTERPOLATE
      Whether when there is a null data point in the data the plot interpolates it or if the lines is split at that point.

      Default false.

    • H_MAJOR_LINES

      public static final PlotOption H_MAJOR_LINES
      Grid option whether to show lines at the major ticks along the horizontal axis.

      Default is true.

    • H_MINOR_LINES

      public static final PlotOption H_MINOR_LINES
      Grid option whether to show lines at the minor ticks along the horizontal axis.

      Default is false.

    • V_MAJOR_LINES

      public static final PlotOption V_MAJOR_LINES
      Grid option whether to show lines at the major ticks along the vertical axis.

      Default is true.

    • V_MINOR_LINES

      public static final PlotOption V_MINOR_LINES
      Grid option whether to show lines at the major ticks along the vertical axis.

      Default is false.

    • H_STRIPES

      public static final PlotOption H_STRIPES
      Grid option whether to show horizontal stripes.

      Default is false.

    • V_STRIPES

      public static final PlotOption V_STRIPES
      Grid option whether to show vertical stripes.

      Default is false.

    • RENDER_ON_AXIS

      public static final PlotOption RENDER_ON_AXIS
      Grid option whether or not the grid is rendered when drawn at horizontal or vertical axis position.

      Default is true.

  • Method Details

    • values

      public static PlotOption[] 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 PlotOption 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