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

Enum Class PlotType

java.lang.Object
java.lang.Enum<PlotType>
com.iizix.prop.ui.chart.plot2d.PlotType
All Implemented Interfaces:
IPropCnrChoiceOption<IPlotChoiceOption>, IPlotChoiceOption, Serializable, Comparable<PlotType>, Constable
public enum PlotType extends Enum<PlotType> implements IPlotChoiceOption
The Plot2D type of the chart.
Author:
Christopher Mindus

  • Enum Constant Details

    • AREAS

      public static final PlotType AREAS
      Area.

    • BARS

      public static final PlotType BARS
      Horizontal bars.

    • BUBBLES

      public static final PlotType BUBBLES
      Bubbles. Note that data for Bubbles requires 3 parameters, in the form of: { x, y, size }, where size determines the size of the bubble.

    • CANDLESTICKS

      public static final PlotType CANDLESTICKS
      Plot that represents typical candlesticks (financial reporting, primarily). Unlike most charts, the Candlestick expects data points to be represented by an object of the form { x?, open, close, high, low, mid? }, where both x and mid are optional parameters. If x is not provided, the index of the data array is used.

    • CLUSTERED_BARS

      public static final PlotType CLUSTERED_BARS
      Grouped or clustered bars (horizontal bars).

    • CLUSTERED_COLUMNS

      public static final PlotType CLUSTERED_COLUMNS
      Grouped or clustered columns (vertical bars).

    • COLUMNS

      public static final PlotType COLUMNS
      Column chart (vertical bars).

    • DEFAULT

      public static final PlotType DEFAULT
      Default uninitialized chart.

    • GRID

      public static final PlotType GRID
      A "faux" plot that can be placed behind other plots to represent a grid against which other plots can be easily measured.

    • INDICATOR

      public static final PlotType INDICATOR
      A "faux" plot that can be placed behind or above other plots to represent a line or multi-line threshold on the chart.

    • LINES

      public static final PlotType LINES
      Typical line chart. (A convenience constructor to create a typical line chart). ??

    • MARKERS

      public static final PlotType MARKERS
      Line chart with markers. (A convenience plot to draw a line chart with markers). ??

    • MARKERS_ONLY

      public static final PlotType MARKERS_ONLY
      Markers only. [A convenience object to draw only markers (like a scatter but not quite)].

    • OHLC

      public static final PlotType OHLC
      Typical open/high/low/close (financial reporting, primarily). Unlike most charts, the Candlestick expects data points to be represented by an object of the form { x?, open, close, high, low, mid? }, where both x and mid are optional parameters. If x is not provided, the index of the data array is used.

    • PIE

      public static final PlotType PIE
      Pie chart.

    • SCATTER

      public static final PlotType SCATTER
      Scatter chart.

    • SPIDER

      public static final PlotType SPIDER
      Spider chart.

    • STACKED

      public static final PlotType STACKED
      Like the default plot, stacked sets up lines, areas and markers in a stacked fashion (values on the y axis added to each other) as opposed to a direct one.

    • STACKED_AREAS

      public static final PlotType STACKED_AREAS
      Stacked areas. (A convenience object to set up a stacked area plot).

    • STACKED_BARS

      public static final PlotType STACKED_BARS
      Stacked bar chart (horizontal bars).

    • STACKED_COLUMNS

      public static final PlotType STACKED_COLUMNS
      Stacked column chart (vertical bars).

    • STACKED_LINES

      public static final PlotType STACKED_LINES
      Stacked line chart.

  • Method Details

    • values

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

    • getDefault

      public PlotType getDefault()
      Gets the default value. This value is used to initialize the property.
      Specified by:
      getDefault in interface IPropCnrChoiceOption<IPlotChoiceOption>
      Returns:
      AREAS.

    • enumValues

      public PlotType[] enumValues()
      Gets all the choices possible, including default.
      Specified by:
      enumValues in interface IPropCnrChoiceOption<IPlotChoiceOption>

    • getInt

      public int getInt()
      Returns the choice as an integer value.
      Specified by:
      getInt in interface IPropCnrChoiceOption<IPlotChoiceOption>

    • getPropName

      public String getPropName()
      Gets the property name.
      Specified by:
      getPropName in interface IPropCnrChoiceOption<IPlotChoiceOption>

    • getSeriesTypes

      public SeriesType[] getSeriesTypes()
      Gets the possible series type for the plot type.
      Returns:
      An array of series types.