Enum PlotOption

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

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

      Enum Constants 
      Enum ConstantDescription
      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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleangetDefaultValue()
      Gets the default value when the property is not set.
      java.lang.StringgetPropName()
      Returns the name of the property, usually starting with '$'.
      static PlotOptionvalueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PlotOption[]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

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

      • values

        public static PlotOption[] 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 (PlotOption c : PlotOption.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

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