Namespace EasyXLS.Charts

Class ExcelDataLabels

System.Object

EasyXLS.Drawings.DrawingObject

EasyXLS.Drawings.LineDrawingObject

EasyXLS.Drawings.FillDrawingObject

EasyXLS.Drawings.EffectDrawingObject

EasyXLS.Drawings.FontDrawingObject

EasyXLS.Drawings.AlignDrawingObject

EasyXLS.Charts.ExcelDataLabels

All Implemented Interfaces:

IAlignDrawingObject, IEffectDrawingObject, IFontDrawingObject

public class ExcelDataLabels
extends AlignDrawingObject

This class stores the data labels settings like label options, number format, fill settings, line settings, (font settings), 3D-format settings, alignment settings and shadow settings.

Constructor Summary

Constructors

Constructor	Description
ExcelDataLabels()	Defines an instance of the data label.

Method Summary

Modifier and Type	Method	Description
System.String	getLabelPosition()	Returns the label position.
System.String	getNumberFormat()	Returns the data label number format.
System.String	getSeparator()	Returns the label separator.
bool	getShowLegendKeyNextToLabel()	Returns a value representing the visibility of the legend key.
bool	IsNumberFormatLinked()	Returns true, if the number format of the labels is the same as the number format of the data source, false otherwise.
void	setLabelPosition(System.String labelPosition)	Sets the label position.
void	setNumberFormat(System.String numberFormat)	Sets the data label number format.
void	setNumberFormatLinked(bool isNumberFormatLinked)	Sets if the number format of the data label is linked to the number format of the data source.
void	setSeparator(System.String separator)	Sets the label separator.
void	setShowBubbleSize(bool show)	Sets if the bubble size is visible in the data label.
void	setShowCategoryName(bool show)	Sets if the category name is visible in the data label.
void	setShowLeaderLines(bool show)	Sets if the leader lines are visible.
void	setShowLegendKeyNextToLabel(bool value)	Sets the visibility of the legend key next to label of the series.
void	setShowPercentage(bool show)	Sets if the percentage is visible in the data label.
void	setShowSeriesName(bool show)	Sets if the series name is visible in the data label.
void	setShowValue(bool show)	Sets if the value is visible in the data label.
bool	ShowBubbleSize()	Returns true if the bubble size is shown in the data label, false otherwise.
bool	ShowCategoryName()	Returns true if the category name is shown in the data label, false otherwise.
bool	ShowLeaderLines()	Returns true if the leader lines are shown, false otherwise.
bool	ShowPercentage()	Returns true if the percentage is shown in the data label, false otherwise.
bool	ShowSeriesName()	Returns true if the series name is shown in the data label, false otherwise.
bool	ShowValue()	Returns true if the value is shown in the data label, false otherwise.

Methods inherited from class EasyXLS.Drawings.AlignDrawingObject

getAlignmentFormat, setAlignmentFormat

Methods inherited from class EasyXLS.Drawings.FontDrawingObject

getFontFormat, setFontFormat

Methods inherited from class EasyXLS.Drawings.EffectDrawingObject

get3DFormat, set3DFormat

Methods inherited from class EasyXLS.Drawings.FillDrawingObject

getFillFormat, setFillFormat

Methods inherited from class EasyXLS.Drawings.LineDrawingObject

getLineColorFormat, getLineStyleFormat, getShadowFormat, setLineColorFormat, setLineStyleFormat, setShadowFormat

Methods inherited from class EasyXLS.Drawings.DrawingObject

getHeight, getHorizontalOffset, getRelativeHeight, getRelativeHorizontalOffset, getRelativeVerticalOffset, getRelativeWidth, getVerticalOffset, getWidth, setLeftUpperOffset, setRelativeLeftUpperOffset, setRelativeSize, setSize

Methods inherited from class System.Object

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

Constructor Details

ExcelDataLabels

public ExcelDataLabels()

Defines an instance of the data label.

Method Details

ShowSeriesName

public bool ShowSeriesName()

Returns true if the series name is shown in the data label, false otherwise.

Returns:

returns true if the series name is shown in the data label, false otherwise

See Also:

setShowSeriesName(bool), ShowCategoryName(), ShowValue(), ShowPercentage(), ShowBubbleSize()

setShowSeriesName

public void setShowSeriesName(bool show)

Sets if the series name is visible in the data label.

Parameters:

show - true if the series name is shown in the data label, false otherwise

See Also:

ShowSeriesName(), setShowCategoryName(bool), setShowValue(bool), setShowPercentage(bool), setShowBubbleSize(bool)

ShowCategoryName

public bool ShowCategoryName()

Returns true if the category name is shown in the data label, false otherwise.

Returns:

returns true if the category name is shown in the data label, false otherwise

See Also:

setShowCategoryName(bool), ShowSeriesName(), ShowValue(), ShowPercentage(), ShowBubbleSize()

setShowCategoryName

public void setShowCategoryName(bool show)

Sets if the category name is visible in the data label.

Parameters:

show - true if the category name is shown in the data label, false otherwise

See Also:

ShowCategoryName(), setShowSeriesName(bool), setShowValue(bool), setShowPercentage(bool), setShowBubbleSize(bool)

ShowValue

public bool ShowValue()

Returns true if the value is shown in the data label, false otherwise.

Returns:

returns true if the value is shown in the data label, false otherwise

See Also:

setShowValue(bool), ShowCategoryName(), ShowSeriesName(), ShowPercentage(), ShowBubbleSize()

setShowValue

public void setShowValue(bool show)

Sets if the value is visible in the data label.

Parameters:

show - true if the value is shown in the data label, false otherwise

See Also:

ShowValue(), setShowCategoryName(bool), setShowSeriesName(bool), setShowPercentage(bool), setShowBubbleSize(bool)

ShowPercentage

public bool ShowPercentage()

Returns true if the percentage is shown in the data label, false otherwise. It is valid only for pie charts.

Returns:

returns true if the percentage is shown in the data label, false otherwise

See Also:

setShowPercentage(bool), ShowCategoryName(), ShowSeriesName(), ShowValue(), ShowBubbleSize()

setShowPercentage

public void setShowPercentage(bool show)

Sets if the percentage is visible in the data label. It is valid only for pie charts.

Parameters:

show - true if the percentage is shown in the data label, false otherwise

See Also:

ShowPercentage(), setShowCategoryName(bool), setShowSeriesName(bool), setShowValue(bool), setShowBubbleSize(bool)

ShowBubbleSize

public bool ShowBubbleSize()

Returns true if the bubble size is shown in the data label, false otherwise. It is valid only for bubble charts.

Returns:

returns true if the bubble size is shown in the data label, false otherwise

See Also:

setShowBubbleSize(bool), ShowCategoryName(), ShowSeriesName(), ShowValue(), ShowPercentage()

setShowBubbleSize

public void setShowBubbleSize(bool show)

Sets if the bubble size is visible in the data label. It is valid only for pie charts.

Parameters:

show - true if the bubble size is shown in the data label, false otherwise

See Also:

ShowBubbleSize(), setShowCategoryName(bool), setShowSeriesName(bool), setShowValue(bool), setShowPercentage(bool)

ShowLeaderLines

public bool ShowLeaderLines()

Returns true if the leader lines are shown, false otherwise.

Returns:

returns true if the leader lines are shown, false otherwise

See Also:

setShowLeaderLines(bool)

setShowLeaderLines

public void setShowLeaderLines(bool show)

Sets if the leader lines are visible.

Parameters:

show - true if the leader lines are shown, false otherwise

See Also:

ShowLeaderLines()

getLabelPosition

public System.String getLabelPosition()

Returns the label position. Possible values are available in Chart class.

Returns:

the label position

See Also:

setLabelPosition(System.String)

setLabelPosition

public void setLabelPosition(System.String labelPosition)

Sets the label position. Possible values are available in Chart class.

Parameters:

labelPosition - the label position

See Also:

getLabelPosition()

getShowLegendKeyNextToLabel

public bool getShowLegendKeyNextToLabel()

Returns a value representing the visibility of the legend key.

Returns:

the visibility of the legend key

See Also:

setShowLegendKeyNextToLabel(bool)

setShowLegendKeyNextToLabel

public void setShowLegendKeyNextToLabel(bool value)

Sets the visibility of the legend key next to label of the series.

Parameters:

value - the new value of the legend key visibility

See Also:

getShowLegendKeyNextToLabel()

getSeparator

public System.String getSeparator()

Returns the label separator. Preset values are available in Chart class.

Returns:

the label separator

See Also:

setSeparator(System.String), ShowCategoryName(), ShowSeriesName(), ShowValue(), ShowPercentage(), ShowBubbleSize()

setSeparator

public void setSeparator(System.String separator)

Sets the label separator. Preset values are available in Chart class.

Parameters:

separator - the label separator

See Also:

getSeparator(), ShowCategoryName(), ShowSeriesName(), ShowValue(), ShowPercentage(), ShowBubbleSize()

getNumberFormat

public System.String getNumberFormat()

Returns the data label number format. Possible values are available in Format class.

Returns:

the data label number format

See Also:

setNumberFormat(System.String)

setNumberFormat

public void setNumberFormat(System.String numberFormat)

Sets the data label number format. Possible values are available in Format class.

Parameters:

numberFormat - the data label number format

See Also:

getNumberFormat()

setNumberFormatLinked

public void setNumberFormatLinked(bool isNumberFormatLinked)

Sets if the number format of the data label is linked to the number format of the data source.

Parameters:

isNumberFormatLinked - true, if the number format of the labels is the same as the number format of the data source, false otherwise

See Also:

IsNumberFormatLinked()

IsNumberFormatLinked

public bool IsNumberFormatLinked()

Returns true, if the number format of the labels is the same as the number format of the data source, false otherwise.

Returns:

true, if the number format of the labels is the same as the number format of the data source, false otherwise

See Also:

setNumberFormatLinked(bool)