Enum Class PlotKString

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

public enum PlotKString extends Enum<PlotKString> implements IPropCnrKString
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
  • Enum Constant Details

    • ZERO_DATA_MESSAGE

      public static final PlotKString ZERO_DATA_MESSAGE
      Pie: the message drawn in the middle of the chart when the series has no data, or only zeros (dojox zeroDataMessage).

      Default null, nothing is drawn.

    • LEGEND_LABEL

      public static final PlotKString 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

      public static PlotKString[] 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 PlotKString 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 KString getDefaultValue()
      Gets the default value when the property is not set.
      Specified by:
      getDefaultValue in interface IPropCnrKString
      Returns:
      The default value, or null for none.
    • getPropName

      public String getPropName()
      Returns the name of the property, usually starting with '$'.
      Specified by:
      getPropName in interface IPropCnrKString