Enum Class PlotKString
- All Implemented Interfaces:
IPropCnrKString, Serializable, Comparable<PlotKString>, Constable
The Plot2D KString settings that can be set or retrieved: the texts a plot shows to the user, localized like the chart title.
- Author:
- Christopher Mindus
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E>Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionIndicator plot: the text of its entry in the chart's legend, e.g.Pie: the message drawn in the middle of the chart when the series has no data, or only zeros (dojoxzeroDataMessage).Method Summary
Modifier and TypeMethodDescriptionGets the default value when the property is not set.Returns the name of the property, usually starting with '$'.static PlotKStringReturns the enum constant of this class with the specified name.static PlotKString[]values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfMethods inherited from interface IPropCnrKString
validate
Enum Constant Details
ZERO_DATA_MESSAGE
Pie: the message drawn in the middle of the chart when the series has no data, or only zeros (dojoxzeroDataMessage).Default null, nothing is drawn.
LEGEND_LABEL
Indicator plot: the text of its entry in the chart's legend, e.g. "Warning level (80 %)". The legend lists the series; an indicator plot with this text gets an entry of its own after them, its swatch drawn as its line (CC-FIX-DASHBOARD-CHARTS).Default null, no entry.
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
Gets the default value when the property is not set.- Specified by:
getDefaultValuein interfaceIPropCnrKString- Returns:
- The default value, or null for none.
getPropName
Returns the name of the property, usually starting with '$'.- Specified by:
getPropNamein interfaceIPropCnrKString