SeriesHintOptionsBase Class

The base class for classes that define series hint options.

Declaration

public abstract class SeriesHintOptionsBase
extends ChartElement

Inheritance

Object
ChartElement
SeriesHintOptionsBase

Inherited Members

java.lang.Object.equals(java.lang.Object)
java.lang.Object.hashCode()
java.lang.Object.notify()
java.lang.Object.notifyAll()
java.lang.Object.toString()
java.lang.Object.wait()
java.lang.Object.wait(long)
java.lang.Object.wait(long, int)

Constructors

SeriesHintOptionsBase() Constructor

Initializes a new SeriesHintOptionsBase class instance with default parameters.

Declaration

public SeriesHintOptionsBase()

Methods

SeriesHintOptionsBase.getPointTextPattern() Method

Returns the text pattern for a point's hint text.

Declaration

public String getPointTextPattern()

Returns

Type Description
String

A text pattern.

SeriesHintOptionsBase.isEnabled() Method

Returns the value that indicates whether a series's hints are enabled.

Declaration

public boolean isEnabled()

Returns

Type Description
boolean

true if hints are enabled; otherwise false.

SeriesHintOptionsBase.setEnabled(boolean) Method

Specifies the value that indicates whether a series's hints are enabled.

Declaration

public void setEnabled(boolean value)

Parameters

Type Name Description
boolean value

true if hints are enabled; otherwise false.

SeriesHintOptionsBase.setPointTextPattern(String) Method

Specifies the text pattern for a point's hint text.

Declaration

public void setPointTextPattern(String pattern)

Parameters

Type Name Description
String pattern

A text pattern.

The following placeholders are available for a text pattern:

Placeholder Description
{S} Displays a series name.
{A} Displays a series point argument.
{V} Displays a series point value.
{VP} Displays a series point value as percentages.
{W} Displays a Bubble series point weight.
{O} Displays a financial series point open value.
{H} Displays a financial series point high value.
{L} Displays a financial series point low value.
{C} Displays a financial series point close value.
Note

These values can be formatted using default format strings going after the $ sign. For example, in the {VP$#.##} string, VP is a placeholder, $ is a format string separator, and #.## is a format string.