Enum Class ChartOption

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

public enum ChartOption extends Enum<ChartOption> implements IPropCnrBoolean
The chart boolean settings the can be set or retrieved.
Author:
Christopher Mindus
  • Enum Constant Details

    • LEGEND

      public static final ChartOption LEGEND
      Whether or not the chart shows a legend: one entry per series, the series name with a swatch of its color, using the dojox chart Legend widget. The legend is placed at the LegendPosition of the chart and follows the series of the chart, i.e. it is rebuilt when a series is added, removed or renamed. The size of the swatches is ChartInteger.LEGEND_SWATCH_SIZE.

      Defaults to false.

    • LEGEND_SELECTABLE

      public static final ChartOption LEGEND_SELECTABLE
      Whether the legend is selectable, i.e. the dojox chart SelectableLegend widget with a check box per entry: clicking an entry hides or shows its series in the client. The selection is a client-side view state only, it is not sent to the server and does not change the $hidden option of the series. It is kept when the chart is rendered again in the same client. Without LEGEND this option has no effect; the swatch size is ChartInteger.LEGEND_SWATCH_SIZE here too.

      Defaults to false.

    • HTML_LABELS

      public static final ChartOption HTML_LABELS
      Whether the chart draws its labels (title, axes) in HTML, as opposed to the vector graphics engine (dojox htmlLabels). The Designer has edited it on the chart for years; this is its Java accessor.

      Defaults to true.

    • CLICK_EVENTS

      public static final ChartOption CLICK_EVENTS
      Whether a click (or a tap) on a data element of the chart - a marker, a column, a bar, a pie slice, a bubble - is sent to the server as a UIChartEvent of the type UIChartEvent.Type.CLICK: the method tagged with OnUIChart for the chart and the listeners added with UIChart.addChartListener(IUIChartListener) receive it. When off, the client sends nothing and the server ignores a click event the client would send anyway. A line plot without markers has no data element to click: turn its markers on. A disabled chart (setEnabled(false)) sends no event, and the server refuses one sent for it.

      Defaults to false.

    • HOVER_EVENTS

      public static final ChartOption HOVER_EVENTS
      Whether the pointer of a mouse entering and leaving the data elements of the chart is sent to the server as UIChartEvent of the types UIChartEvent.Type.HOVER and UIChartEvent.Type.LEAVE. The client sends the element the pointer rests on for 150 ms, so that a pointer crossing a chart does not send an event per marker; a HOVER replaces the previous one, a LEAVE says the pointer rests on no element - also when the element went because its plot drew again (new values of a live series). A finger has no hover: on a touch screen use CLICK_EVENTS. When off, the client sends nothing and the server ignores a hover event the client would send anyway.

      Defaults to false.

  • Method Details

    • values

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