Enum Class ChartOption
- All Implemented Interfaces:
IPropCnrBoolean, Serializable, Comparable<ChartOption>, Constable
The chart 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 ConstantsEnum ConstantDescriptionWhether 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 aUIChartEventof the typeUIChartEvent.Type.CLICK: the method tagged withOnUIChartfor the chart and the listeners added withUIChart.addChartListener(IUIChartListener)receive it.Whether the pointer of a mouse entering and leaving the data elements of the chart is sent to the server asUIChartEventof the typesUIChartEvent.Type.HOVERandUIChartEvent.Type.LEAVE.Whether the chart draws its labels (title, axes) in HTML, as opposed to the vector graphics engine (dojoxhtmlLabels).Whether or not the chart shows a legend: one entry per series, the series name with a swatch of its color, using the dojox chartLegendwidget.Whether the legend is selectable, i.e.Method Summary
Modifier and TypeMethodDescriptionbooleanGets the default value when the property is not set.Returns the name of the property, usually starting with '$'.static ChartOptionReturns the enum constant of this class with the specified name.static ChartOption[]values()Returns an array containing the constants of this enum class, in the order they are declared.
Enum Constant Details
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 chartLegendwidget. The legend is placed at theLegendPositionof 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 isChartInteger.LEGEND_SWATCH_SIZE.Defaults to false.
LEGEND_SELECTABLE
Whether the legend is selectable, i.e. the dojox chartSelectableLegendwidget 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$hiddenoption of the series. It is kept when the chart is rendered again in the same client. WithoutLEGENDthis option has no effect; the swatch size isChartInteger.LEGEND_SWATCH_SIZEhere too.Defaults to false.
HTML_LABELS
Whether the chart draws its labels (title, axes) in HTML, as opposed to the vector graphics engine (dojoxhtmlLabels). The Designer has edited it on the chart for years; this is its Java accessor.Defaults to true.
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 aUIChartEventof the typeUIChartEvent.Type.CLICK: the method tagged withOnUIChartfor the chart and the listeners added withUIChart.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
Whether the pointer of a mouse entering and leaving the data elements of the chart is sent to the server asUIChartEventof the typesUIChartEvent.Type.HOVERandUIChartEvent.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 useCLICK_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
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
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 nameNullPointerException- if the argument is null
getDefaultValue
public boolean getDefaultValue()Gets the default value when the property is not set.- Specified by:
getDefaultValuein interfaceIPropCnrBoolean
getPropName
Returns the name of the property, usually starting with '$'.- Specified by:
getPropNamein interfaceIPropCnrBoolean