com.cete.dynamicpdf.pageelements.charting
Class ScalarDataLabel

java.lang.Object
  com.cete.dynamicpdf.pageelements.charting.ScalarDataLabel

public class ScalarDataLabel
extends java.lang.Object

This class represents scalar data label.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Constructor Summary

ScalarDataLabel(boolean showValue)
Initializes a new instance of the ScalarDataLabel class.

ScalarDataLabel(boolean showValue, boolean showElement)
Initializes a new instance of the ScalarDataLabel class.

ScalarDataLabel(boolean showValue, boolean showPercentage, boolean showElement)
Initializes a new instance of the ScalarDataLabel class.

ScalarDataLabel(Font font, float fontSize, Color color, boolean showValue)
Initializes a new instance of the ScalarDataLabel class.

Method Summary

Color	getColor() Gets the Color object to use for the color of the scalar data label.
Font	getFont() Gets the Font object to use for the font of the scalar data label.
float	getFontSize() Gets the font size of the scalar data label.
java.lang.String	getPrefix() Gets the prefix of the scalar data label.
java.lang.String	getSeparator() Gets the separator of the scalar data label.
java.lang.String	getSeperator() Deprecated. as of DynamicPDF v8.0.0 replaced by getSeparator()
boolean	getShowElement() Gets visible status of the pie series element name.
boolean	getShowPercentage() Gets visible status of the pie series element value in percentage.
boolean	getShowValue() Gets visible status of the pie series element value.
java.lang.String	getSuffix() Gets the suffix of the scalar data label.
void	setColor(Color color) Sets the Color object to use for the color of the scalar data label.
void	setFont(Font font) Sets the Font object to use for the font of the scalar data label.
void	setFontSize(float fontSize) Sets the font size of the scalar data label.
void	setPrefix(java.lang.String prefix) Sets the prefix of the scalar data label.
void	setSeparator(java.lang.String value) Sets the separator of the scalar data label.
void	setSeperator(java.lang.String value) Deprecated. as of DynamicPDF v8.0.0 replaced by setSeparator(String)
void	setShowElement(boolean showElement) Sets visible status of the pie series element name.
void	setShowPercentage(boolean showPercentage) Sets visible status of the pie series element value in percentage.
void	setShowValue(boolean showValue) Sets visible status of the pie series element value.
void	setSuffix(java.lang.String suffix) Sets the suffix of the scalar data label.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScalarDataLabel

public ScalarDataLabel(boolean showValue)

Initializes a new instance of the ScalarDataLabel class.

Parameters:

showValue - boolean value indicating visible status of the pie series element value.

ScalarDataLabel

public ScalarDataLabel(boolean showValue,
                       boolean showElement)

Initializes a new instance of the ScalarDataLabel class.

Parameters:

showValue - boolean value indicating visible status of the pie series element value.

showElement - boolean value indicating visible status of the pie series element name.

ScalarDataLabel

public ScalarDataLabel(boolean showValue,
                       boolean showPercentage,
                       boolean showElement)

Initializes a new instance of the ScalarDataLabel class.

Parameters:

showValue - boolean value indicating visible status of the pie series element value.

showPercentage - boolean value indicating visible status of the pie series element value in percentage.

showElement - boolean value indicating visible status of the pie series element name.

ScalarDataLabel

public ScalarDataLabel(Font font,
                       float fontSize,
                       Color color,
                       boolean showValue)

Initializes a new instance of the ScalarDataLabel class.

Parameters:

font - Font of the scalar data label.

fontSize - font size of the scalar data label.

color - Color of the scalar data label.

showValue - boolean value indicating visible status of the pie series element value.

Method Detail

getFont

public Font getFont()

Gets the Font object to use for the font of the scalar data label.

Returns:

the font of the scalar data label.

See Also:

Font

setFont

public void setFont(Font font)

Sets the Font object to use for the font of the scalar data label.

Parameters:

font - Font object to use for the font of the scalar data label.

See Also:

Font

getFontSize

public float getFontSize()

Gets the font size of the scalar data label.

Returns:

the float value specifying font size of the scalar data label.

setFontSize

public void setFontSize(float fontSize)

Sets the font size of the scalar data label.

Parameters:

fontSize - the float value used to set font size of the scalar data label.

getColor

public Color getColor()

Gets the Color object to use for the color of the scalar data label.

Returns:

the color of the scalar data label.

See Also:

Color

setColor

public void setColor(Color color)

Sets the Color object to use for the color of the scalar data label.

Parameters:

color - Color object to use for the color of the scalar data label.

See Also:

Color

getSuffix

public java.lang.String getSuffix()

Gets the suffix of the scalar data label.

Returns:

the suffix of the scalar data label.

setSuffix

public void setSuffix(java.lang.String suffix)

Sets the suffix of the scalar data label.

Parameters:

suffix - to set the suffix of the scalar data label.

getPrefix

public java.lang.String getPrefix()

Gets the prefix of the scalar data label.

Returns:

the prefix of the scalar data label.

setPrefix

public void setPrefix(java.lang.String prefix)

Sets the prefix of the scalar data label.

Parameters:

prefix - to set the prefix of the scalar data label.

getSeperator

public java.lang.String getSeperator()

Deprecated. as of DynamicPDF v8.0.0 replaced by getSeparator()

Gets the separator of the scalar data label.

Returns:

the separator of the scalar data label.

setSeperator

public void setSeperator(java.lang.String value)

Deprecated. as of DynamicPDF v8.0.0 replaced by setSeparator(String)

Sets the separator of the scalar data label.

Parameters:

value - string object to set the separator of the scalar data label.

getSeparator

public java.lang.String getSeparator()

Gets the separator of the scalar data label.

Returns:

the separator of the scalar data label.

setSeparator

public void setSeparator(java.lang.String value)

Sets the separator of the scalar data label.

Parameters:

value - string object to set the separator of the scalar data label.

getShowValue

public boolean getShowValue()

Gets visible status of the pie series element value. By default its false.

Returns:

visible status of the pie series element value.

setShowValue

public void setShowValue(boolean showValue)

Sets visible status of the pie series element value. By default its false.

Parameters:

showValue - boolean value to set visible status of the series value.

getShowPercentage

public boolean getShowPercentage()

Gets visible status of the pie series element value in percentage. By default its false.

Returns:

visible status of the pie series element value in percentage.

setShowPercentage

public void setShowPercentage(boolean showPercentage)

Sets visible status of the pie series element value in percentage. By default its false.

Parameters:

showPercentage - boolean value to set the visible status of the series value as a percentage.

getShowElement

public boolean getShowElement()

Gets visible status of the pie series element name. By default its false.

Returns:

visible status of the pie series element name.

setShowElement

public void setShowElement(boolean showElement)

Sets visible status of the pie series element name. By default its false.

Parameters:

showElement - to set visible status of the pie series element name.