The requested page is not available for the requested platform. You are viewing the content for Default platform.

SeriesLabel Class

The base class for all series labels.

Declaration

public abstract class SeriesLabel
extends StyledElement

Inheritance

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

SeriesLabel() Constructor

Initializes a new SeriesLabel class instance with default parameters.

Declaration

public SeriesLabel()

Methods

SeriesLabel.getIndent() Method

Returns an indent from a data point to its label.

Declaration

public int getIndent()

Returns

Type Description
int

The distance between the data point and its label, in pixels.

SeriesLabel.getTextPattern() Method

Returns a text pattern specifying a text which a series point label displays.

Declaration

public String getTextPattern()

Returns

Type Description
String

The text pattern.

SeriesLabel.getTextProvider() Method

Returns the provider of values for series labels.

Declaration

public SeriesLabelTextProvider getTextProvider()

Returns

Type Description
SeriesLabelTextProvider

The object of the class that implement the SeriesLabelTextProvider interface.

SeriesLabel.isVisible() Method

Returns the value indicating whether the series labels are shown in the .

Declaration

public Boolean isVisible()

Returns

Type Description
Boolean

true if series labels are visible; otherwise false.

SeriesLabel.setIndent(int) Method

Specifies an indent from a data point to its label.

Declaration

public void setIndent(int indent)

Parameters

Type Name Description
int indent

The distance between the data point and its label, in pixels.

SeriesLabel.setTextPattern(String) Method

Specifies a text pattern specifying a text which a series point label displays.

Declaration

public void setTextPattern(String pattern)

Parameters

Type Name Description
String pattern

The text pattern.

Remarks

The following placeholders are available for series point labels.

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.
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.

SeriesLabel.setTextProvider(SeriesLabelTextProvider) Method

Specifies the provider of values for series labels.

Declaration

public void setTextProvider(SeriesLabelTextProvider formatter)

Parameters

Type Name Description
SeriesLabelTextProvider formatter

The object of the class that implement the SeriesLabelTextProvider interface.

SeriesLabel.setVisible(Boolean) Method

Specifies the value indicating whether the series labels are shown in the .

Declaration

public void setVisible(Boolean value)

Parameters

Type Name Description
Boolean value

true if series labels are visible; otherwise false.