IDataLabelFormat

All Implemented Interfaces: com.aspose.slides.IFormattedTextContainer

public interface IDataLabelFormat extends IFormattedTextContainer

Represents formatting options for DataLabel.

Methods

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

isNumberFormatLinkedToSource()

public abstract 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().setNumberFormatLinkedToSource(val);” cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

Returns: boolean

setNumberFormatLinkedToSource(boolean value)

public abstract 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().setNumberFormatLinkedToSource(val);” cause to all DataLabels.get_Item(i).isNumberFormatLinkedToSource() is equal to val).

Parameters:

Parameter Type Description
value boolean

getNumberFormat()

public abstract String getNumberFormat()

Represents the format string for the DataLabels object. 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 NumberFormat property for the new data labels in the DataLabelCollection collection. Represents the format string for the DataLabel objects. Set this property with value also sets this value to the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. “DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);” cause to all DataLabels.get_Item(i).getNumberFormat() is equal to val).

Returns: java.lang.String

setNumberFormat(String value)

public abstract void setNumberFormat(String value)

Represents the format string for the DataLabels object. 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 NumberFormat property for the new data labels in the DataLabelCollection collection. Represents the format string for the DataLabel objects. Set this property with value also sets this value to the NumberFormat property for all data labels in the DataLabelCollection collection (i.e. “DataLabels.getDefaultDataLabelFormat().setNumberFormat(val);” cause to all DataLabels.get_Item(i).getNumberFormat() is equal to val).

Parameters:

Parameter Type Description
value java.lang.String

getFormat()

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

Returns: IFormat

getPosition()

public abstract 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).

Returns: int

setPosition(int value)

public abstract 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).

Parameters:

Parameter Type Description
value int

getShowLegendKey()

public abstract 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).

Returns: boolean

setShowLegendKey(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowValue()

public abstract 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).

Returns: boolean

setShowValue(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowCategoryName()

public abstract 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).

Returns: boolean

setShowCategoryName(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowSeriesName()

public abstract 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).

Returns: boolean

setShowSeriesName(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowPercentage()

public abstract 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).

Returns: boolean

setShowPercentage(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowBubbleSize()

public abstract 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).

Returns: boolean

setShowBubbleSize(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowLeaderLines()

public abstract 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).

Returns: boolean

setShowLeaderLines(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowLabelAsDataCallout()

public abstract 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).

Returns: boolean

setShowLabelAsDataCallout(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getShowLabelValueFromCell()

public abstract 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).

Returns: boolean

setShowLabelValueFromCell(boolean value)

public abstract 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).

Parameters:

Parameter Type Description
value boolean

getSeparator()

public abstract 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).

Returns: java.lang.String

setSeparator(String value)

public abstract void setSeparator(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).

Parameters:

Parameter Type Description
value java.lang.String