SeriesHintOptionsBase Class

The base class for classes that define series hint options.

Declaration

public abstract class SeriesHintOptionsBase
extends ChartElement

Inherited Members

java.lang.Object.equals(java.lang.Object)(Object)

Object.getClass()

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)(long)

java.lang.Object.wait(long, int)(long,int)

Inheritance

Object

ChartElement

SeriesHintOptionsBase

SeriesHintOptionsBase()

Initializes a new SeriesHintOptionsBase class instance with default parameters.

Declaration

public SeriesHintOptionsBase()

Methods

getPointTextPattern() Method

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

Declaration

public String getPointTextPattern()

Returns

Type	Description
String	A text pattern.

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.

setEnabled(boolean) Method

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

Declaration

public void setEnabled(boolean value)

Parameters

Name	Type	Description
value	boolean	true if hints are enabled; otherwise false.

setPointTextPattern(String) Method

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

Declaration

public void setPointTextPattern(String pattern)

Parameters

Name	Type	Description
pattern	String	A text pattern.

Remarks

The following placeholders are available for a text pattern:

Placeholder	Description
{S}	Displays a series name.
{A}	Displays a series point argument.
{L}	Displays a pie series point label.
{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.
{HV}	Displays a range bar series point max value.
{LV}	Displays a range bar series point min value.

Note

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