com.aspose.slides

Class DataLabelFormat

java.lang.Object

com.aspose.slides.PVIObject

com.aspose.slides.DataLabelFormat

All Implemented Interfaces:

IChartComponent, IDataLabelFormat, IFormattedTextContainer, IPresentationComponent, ISlideComponent

public final class DataLabelFormat
extends PVIObject
implements IDataLabelFormat

Represents formatting options for DataLabel.

Method Summary

Modifier and Type	Method and Description
IChart	getChart() Returns the chart.
IFormat	getFormat() Represents the format of the data label.
java.lang.String	getNumberFormat() Represents the format string for the DataLabels object.
int	getPosition() Represents the position of the data label.
java.lang.String	getSeparator() Sets or returns a Variant representing the separator used for the data labels on a chart.
boolean	getShowBubbleSize() Represents a specified chart's data label bubble size value display behavior.
boolean	getShowCategoryName() Represents a specified chart's data label category name display behavior.
boolean	getShowLabelAsDataCallout() Determines either specified chart's data label will be displayed as data callout or as data label.
boolean	getShowLabelValueFromCell() Represents a specified chart's data label cell value display behavior.
boolean	getShowLeaderLines() Represents a specified chart's data label leader lines display behavior.
boolean	getShowLegendKey() Represents a specified chart's data label legend key display behavior.
boolean	getShowPercentage() Represents a specified chart's data label percentage value display behavior.
boolean	getShowSeriesName() Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
boolean	getShowValue() Represents a specified chart's data label percentage value display behavior.
IChartTextFormat	getTextFormat() Returns chart text format.
long	getVersion() Version.
boolean	isNumberFormatLinkedToSource() Read/write boolean.
void	setNumberFormat(java.lang.String value) Represents the format string for the DataLabels object.
void	setNumberFormatLinkedToSource(boolean value) Read/write boolean.
void	setPosition(int value) Represents the position of the data label.
void	setSeparator(java.lang.String value) Sets or returns a Variant representing the separator used for the data labels on a chart.
void	setShowBubbleSize(boolean value) Represents a specified chart's data label bubble size value display behavior.
void	setShowCategoryName(boolean value) Represents a specified chart's data label category name display behavior.
void	setShowLabelAsDataCallout(boolean value) Determines either specified chart's data label will be displayed as data callout or as data label.
void	setShowLabelValueFromCell(boolean value) Represents a specified chart's data label cell value display behavior.
void	setShowLeaderLines(boolean value) Represents a specified chart's data label leader lines display behavior.
void	setShowLegendKey(boolean value) Represents a specified chart's data label legend key display behavior.
void	setShowPercentage(boolean value) Represents a specified chart's data label percentage value display behavior.
void	setShowSeriesName(boolean value) Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
void	setShowValue(boolean value) Represents a specified chart's data label percentage value display behavior.

Methods inherited from class com.aspose.slides.PVIObject

equals, getParent_Immediate, getParent_IPresentationComponent, getParent_ISlideComponent, getPresentation, getSlide, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.ISlideComponent

getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent

getPresentation

Method Detail

getVersion

public long getVersion()

Version. Read-only long.

Overrides:

getVersion in class PVIObject

isNumberFormatLinkedToSource

public final boolean isNumberFormatLinkedToSource()

Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the IsNumberFormatLinkedToSource property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the IsNumberFormatLinkedToSource property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().isNumberFormatLinkedToSource(val);" cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

Specified by:

isNumberFormatLinkedToSource in interface IDataLabelFormat

setNumberFormatLinkedToSource

public final void setNumberFormatLinkedToSource(boolean value)

Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the IsNumberFormatLinkedToSource property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the IsNumberFormatLinkedToSource property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().isNumberFormatLinkedToSource(val);" cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

Specified by:

setNumberFormatLinkedToSource in interface IDataLabelFormat

getNumberFormat

public final java.lang.String getNumberFormat()

Represents the format string for the DataLabels object. Read/write String.

 
 series.getLabels().getDefaultDataLabelFormat().setShowValue(true);
 series.getLabels().getDefaultDataLabelFormat().setNumberFormatLinkedToSource(false);
 series.getLabels().getDefaultDataLabelFormat().setNumberFormat("0.0%");
 
 

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels, then this property gets or sets the default value of the NumberFormat property for the new data labels in the DataLabelCollection collection. When this property is set with a value, that value is also set for the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);" causes all DataLabels.get_Item(i).getNumberFormat() to equal to val).

Specified by:

getNumberFormat in interface IDataLabelFormat

setNumberFormat

public final void setNumberFormat(java.lang.String value)

Represents the format string for the DataLabels object. Read/write String.

 
 series.getLabels().getDefaultDataLabelFormat().setShowValue(true);
 series.getLabels().getDefaultDataLabelFormat().setNumberFormatLinkedToSource(false);
 series.getLabels().getDefaultDataLabelFormat().setNumberFormat("0.0%");
 
 

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels, then this property gets or sets the default value of the NumberFormat property for the new data labels in the DataLabelCollection collection. When this property is set with a value, that value is also set for the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);" causes all DataLabels.get_Item(i).getNumberFormat() to equal to val).

Specified by:

setNumberFormat in interface IDataLabelFormat

getFormat

public final IFormat getFormat()

Represents the format of the data label. Read-only IFormat.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property represents the default format for the new data labels in the DataLabelCollection collection.

Specified by:

getFormat in interface IDataLabelFormat

getPosition

public final int getPosition()

Represents the position of the data label. Read/write LegendDataLabelPosition.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Position property for the new data labels in the DataLabelCollection collection. Represents the position for the DataLabel objects. Set this property with value also sets this value to the Position property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setPosition(val);" cause to all DataLabels.get_Item(i).getPosition() is equal to val).

Specified by:

getPosition in interface IDataLabelFormat

setPosition

public final void setPosition(int value)

Represents the position of the data label. Read/write LegendDataLabelPosition.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Position property for the new data labels in the DataLabelCollection collection. Represents the position for the DataLabel objects. Set this property with value also sets this value to the Position property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setPosition(val);" cause to all DataLabels.get_Item(i).getPosition() is equal to val).

Specified by:

setPosition in interface IDataLabelFormat

getShowLegendKey

public final boolean getShowLegendKey()

Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLegendKey property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLegendKey property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLegendKey(val);" cause to all DataLabels.get_Item(i).getShowLegendKey() is equal to val).

Specified by:

getShowLegendKey in interface IDataLabelFormat

setShowLegendKey

public final void setShowLegendKey(boolean value)

Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLegendKey property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLegendKey property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLegendKey(val);" cause to all DataLabels.get_Item(i).getShowLegendKey() is equal to val).

Specified by:

setShowLegendKey in interface IDataLabelFormat

getShowValue

public final boolean getShowValue()

Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowValue property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowValue property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowValue(val);" cause to all DataLabels.get_Item(i).getShowValue() is equal to val).

Specified by:

getShowValue in interface IDataLabelFormat

setShowValue

public final void setShowValue(boolean value)

Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowValue property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowValue property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowValue(val);" cause to all DataLabels.get_Item(i).getShowValue() is equal to val).

Specified by:

setShowValue in interface IDataLabelFormat

getShowCategoryName

public final boolean getShowCategoryName()

Represents a specified chart's data label category name display behavior. True to display the category name for the data labels on a chart. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowCategoryName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowCategoryName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowCategoryName(val);" cause to all DataLabels.get_Item(i).getShowCategoryName() is equal to val).

Specified by:

getShowCategoryName in interface IDataLabelFormat

setShowCategoryName

public final void setShowCategoryName(boolean value)

Represents a specified chart's data label category name display behavior. True to display the category name for the data labels on a chart. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowCategoryName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowCategoryName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowCategoryName(val);" cause to all DataLabels.get_Item(i).getShowCategoryName() is equal to val).

Specified by:

setShowCategoryName in interface IDataLabelFormat

getShowSeriesName

public final boolean getShowSeriesName()

Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart. True to show the series name. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowSeriesName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowSeriesName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowSeriesName(val);" cause to all DataLabels.get_Item(i).getShowSeriesName() is equal to val).

Specified by:

getShowSeriesName in interface IDataLabelFormat

setShowSeriesName

public final void setShowSeriesName(boolean value)

Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart. True to show the series name. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowSeriesName property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowSeriesName property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowSeriesName(val);" cause to all DataLabels.get_Item(i).getShowSeriesName() is equal to val).

Specified by:

setShowSeriesName in interface IDataLabelFormat

getShowPercentage

public final boolean getShowPercentage()

Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowPercentage property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowPercentage property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowPercentage(val);" cause to all DataLabels.get_Item(i).getShowPercentage() is equal to val).

Specified by:

getShowPercentage in interface IDataLabelFormat

setShowPercentage

public final void setShowPercentage(boolean value)

Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowPercentage property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowPercentage property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowPercentage(val);" cause to all DataLabels.get_Item(i).getShowPercentage() is equal to val).

Specified by:

setShowPercentage in interface IDataLabelFormat

getShowBubbleSize

public final boolean getShowBubbleSize()

Represents a specified chart's data label bubble size value display behavior. True displays the bubble size value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowBubbleSize property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowBubbleSize property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowBubbleSize(val);" cause to all DataLabels.get_Item(i).getShowBubbleSize() is equal to val).

Specified by:

getShowBubbleSize in interface IDataLabelFormat

setShowBubbleSize

public final void setShowBubbleSize(boolean value)

Represents a specified chart's data label bubble size value display behavior. True displays the bubble size value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowBubbleSize property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowBubbleSize property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowBubbleSize(val);" cause to all DataLabels.get_Item(i).getShowBubbleSize() is equal to val).

Specified by:

setShowBubbleSize in interface IDataLabelFormat

getShowLeaderLines

public final boolean getShowLeaderLines()

Represents a specified chart's data label leader lines display behavior. True displays the leader lines. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLeaderLines property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLeaderLines property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLeaderLines(val);" cause to all DataLabels.get_Item(i).getShowLeaderLines() is equal to val).

Specified by:

getShowLeaderLines in interface IDataLabelFormat

setShowLeaderLines

public final void setShowLeaderLines(boolean value)

Represents a specified chart's data label leader lines display behavior. True displays the leader lines. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLeaderLines property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLeaderLines property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLeaderLines(val);" cause to all DataLabels.get_Item(i).getShowLeaderLines() is equal to val).

Specified by:

setShowLeaderLines in interface IDataLabelFormat

getShowLabelValueFromCell

public final boolean getShowLabelValueFromCell()

Represents a specified chart's data label cell value display behavior. True displays cell value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelValueFromCell property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelValueFromCell property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelValueFromCell(val);" cause to all DataLabels.get_Item(i).getShowLabelValueFromCell() is equal to val).

Specified by:

getShowLabelValueFromCell in interface IDataLabelFormat

setShowLabelValueFromCell

public final void setShowLabelValueFromCell(boolean value)

Represents a specified chart's data label cell value display behavior. True displays cell value. False to hide. Read/write boolean.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelValueFromCell property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelValueFromCell property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelValueFromCell(val);" cause to all DataLabels.get_Item(i).getShowLabelValueFromCell() is equal to val).

Specified by:

setShowLabelValueFromCell in interface IDataLabelFormat

getShowLabelAsDataCallout

public final boolean getShowLabelAsDataCallout()

Determines either specified chart's data label will be displayed as data callout or as data label.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelAsDataCallout property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelAsDataCallout property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelAsDataCallout(val);" cause to all DataLabels.get_Item(i).getShowLabelAsDataCallout() is equal to val).

Specified by:

getShowLabelAsDataCallout in interface IDataLabelFormat

setShowLabelAsDataCallout

public final void setShowLabelAsDataCallout(boolean value)

Determines either specified chart's data label will be displayed as data callout or as data label.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the ShowLabelAsDataCallout property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the ShowLabelAsDataCallout property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setShowLabelAsDataCallout(val);" cause to all DataLabels.get_Item(i).getShowLabelAsDataCallout() is equal to val).

Specified by:

setShowLabelAsDataCallout in interface IDataLabelFormat

getSeparator

public final java.lang.String getSeparator()

Sets or returns a Variant representing the separator used for the data labels on a chart. Read/write String.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Separator property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the Separator property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setSeparator(val);" cause to all DataLabels.get_Item(i).getSeparator() is equal to val).

Specified by:

getSeparator in interface IDataLabelFormat

setSeparator

public final void setSeparator(java.lang.String value)

Sets or returns a Variant representing the separator used for the data labels on a chart. Read/write String.

If parent of this DataLabelFormat object is a DataLabelCollection collection of data labels then this property gets or sets the default value of the Separator property for the new data labels in the DataLabelCollection collection. Set this property with value also sets this value to the Separator property for all data labels in the DataLabelCollection collection (i.e. "DataLabels.getDefaultDataLabelFormat().setSeparator(val);" cause to all DataLabels.get_Item(i).getSeparator() is equal to val).

Specified by:

setSeparator in interface IDataLabelFormat

getTextFormat

public final IChartTextFormat getTextFormat()

Returns chart text format. Read-only IChartTextFormat.

Specified by:

getTextFormat in interface IFormattedTextContainer

getChart

public final IChart getChart()

Returns the chart. Read-only IChart.

Specified by:

getChart in interface IChartComponent