ChartDataLabelCollection (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.ChartDataLabelCollection

All Implemented Interfaces:

java.lang.Iterable
```
public class ChartDataLabelCollection
extends java.lang.Object
implements java.lang.Iterable
```
Represents a collection of ChartDataLabel.
To learn more, visit the Working with Charts documentation article.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFormat()` Clears format of all `ChartDataLabel` in this collection.
`ChartDataLabel`	`get(int index)` Returns `ChartDataLabel` for the specified index.
`int`	`getCount()` Returns the number of `ChartDataLabel` in this collection.
`ChartNumberFormat`	`getNumberFormat()` Gets an `ChartNumberFormat` instance allowing to set number format for the data labels of the entire series.
`java.lang.String`	`getSeparator()` Gets string separator used for the data labels of the entire series.
`boolean`	`getShowBubbleSize()` Allows to specify whether bubble size is to be displayed for the data labels of the entire series.
`boolean`	`getShowCategoryName()` Allows to specify whether category name is to be displayed for the data labels of the entire series.
`boolean`	`getShowDataLabelsRange()` Allows to specify whether values from data labels range to be displayed in the data labels of the entire series.
`boolean`	`getShowLeaderLines()` Allows to specify whether data label leader lines need be shown for the data labels of the entire series.
`boolean`	`getShowLegendKey()` Allows to specify whether legend key is to be displayed for the data labels of the entire series.
`boolean`	`getShowPercentage()` Allows to specify whether percentage value is to be displayed for the data labels of the entire series.
`boolean`	`getShowSeriesName()` Gets a Boolean to indicate the series name display behavior for the data labels of the entire series.
`boolean`	`getShowValue()` Allows to specify whether values are to be displayed in the data labels of the entire series.
`boolean`	`isInherited()`
`java.util.Iterator`	`iterator()` Returns an enumerator object.
`void`	`setSeparator(java.lang.String value)` Sets string separator used for the data labels of the entire series.
`void`	`setShowBubbleSize(boolean value)` Allows to specify whether bubble size is to be displayed for the data labels of the entire series.
`void`	`setShowCategoryName(boolean value)` Allows to specify whether category name is to be displayed for the data labels of the entire series.
`void`	`setShowDataLabelsRange(boolean value)` Allows to specify whether values from data labels range to be displayed in the data labels of the entire series.
`void`	`setShowLeaderLines(boolean value)` Allows to specify whether data label leader lines need be shown for the data labels of the entire series.
`void`	`setShowLegendKey(boolean value)` Allows to specify whether legend key is to be displayed for the data labels of the entire series.
`void`	`setShowPercentage(boolean value)` Allows to specify whether percentage value is to be displayed for the data labels of the entire series.
`void`	`setShowSeriesName(boolean value)` Sets a Boolean to indicate the series name display behavior for the data labels of the entire series.
`void`	`setShowValue(boolean value)` Allows to specify whether values are to be displayed in the data labels of the entire series.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - get
```
public ChartDataLabel get(int index)
```
    Returns ChartDataLabel for the specified index.
    
    Returns:
    
    ChartDataLabel for the specified index.
  - iterator
```
public java.util.Iterator iterator()
```
    Returns an enumerator object.
    
    Specified by:
    
    iterator in interface java.lang.Iterable
  - clearFormat
```
public void clearFormat()
```
    Clears format of all ChartDataLabel in this collection.
  - getCount
```
public int getCount()
```
    Returns the number of ChartDataLabel in this collection.
    
    Returns:
    
    The number of ChartDataLabel in this collection.
  - getShowCategoryName
```
public boolean getShowCategoryName()
```
    Allows to specify whether category name is to be displayed for the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowCategoryName() / ChartDataLabel.setShowCategoryName(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowCategoryName
```
public void setShowCategoryName(boolean value)
```
    Allows to specify whether category name is to be displayed for the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowCategoryName() / ChartDataLabel.setShowCategoryName(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowBubbleSize
```
public boolean getShowBubbleSize()
```
    Allows to specify whether bubble size is to be displayed for the data labels of the entire series. Applies only to Bubble charts. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowBubbleSize() / ChartDataLabel.setShowBubbleSize(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowBubbleSize
```
public void setShowBubbleSize(boolean value)
```
    Allows to specify whether bubble size is to be displayed for the data labels of the entire series. Applies only to Bubble charts. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowBubbleSize() / ChartDataLabel.setShowBubbleSize(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowLegendKey
```
public boolean getShowLegendKey()
```
    Allows to specify whether legend key is to be displayed for the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowLegendKey() / ChartDataLabel.setShowLegendKey(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowLegendKey
```
public void setShowLegendKey(boolean value)
```
    Allows to specify whether legend key is to be displayed for the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowLegendKey() / ChartDataLabel.setShowLegendKey(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowPercentage
```
public boolean getShowPercentage()
```
    Allows to specify whether percentage value is to be displayed for the data labels of the entire series. Default value is false. Applies only to Pie charts. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowPercentage() / ChartDataLabel.setShowPercentage(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowPercentage
```
public void setShowPercentage(boolean value)
```
    Allows to specify whether percentage value is to be displayed for the data labels of the entire series. Default value is false. Applies only to Pie charts. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowPercentage() / ChartDataLabel.setShowPercentage(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowSeriesName
```
public boolean getShowSeriesName()
```
    Gets a Boolean to indicate the series name display behavior for the data labels of the entire series. True to show the series name. False to hide. By default false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowSeriesName() / ChartDataLabel.setShowSeriesName(boolean) property.
    
    Returns:
    
    A Boolean to indicate the series name display behavior for the data labels of the entire series.
  - setShowSeriesName
```
public void setShowSeriesName(boolean value)
```
    Sets a Boolean to indicate the series name display behavior for the data labels of the entire series. True to show the series name. False to hide. By default false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowSeriesName() / ChartDataLabel.setShowSeriesName(boolean) property.
    
    Parameters:
    
    value - A Boolean to indicate the series name display behavior for the data labels of the entire series.
  - getShowValue
```
public boolean getShowValue()
```
    Allows to specify whether values are to be displayed in the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowValue() / ChartDataLabel.setShowValue(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowValue
```
public void setShowValue(boolean value)
```
    Allows to specify whether values are to be displayed in the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowValue() / ChartDataLabel.setShowValue(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowLeaderLines
```
public boolean getShowLeaderLines()
```
    Allows to specify whether data label leader lines need be shown for the data labels of the entire series. Default value is false.
    Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.
    
    Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowLeaderLines() / ChartDataLabel.setShowLeaderLines(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowLeaderLines
```
public void setShowLeaderLines(boolean value)
```
    Allows to specify whether data label leader lines need be shown for the data labels of the entire series. Default value is false.
    Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.
    
    Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowLeaderLines() / ChartDataLabel.setShowLeaderLines(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowDataLabelsRange
```
public boolean getShowDataLabelsRange()
```
    Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowDataLabelsRange() / ChartDataLabel.setShowDataLabelsRange(boolean) property.
    
    Returns:
    
    The corresponding boolean value.
  - setShowDataLabelsRange
```
public void setShowDataLabelsRange(boolean value)
```
    Allows to specify whether values from data labels range to be displayed in the data labels of the entire series. Default value is false. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getShowDataLabelsRange() / ChartDataLabel.setShowDataLabelsRange(boolean) property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSeparator
```
public java.lang.String getSeparator()
```
    Gets string separator used for the data labels of the entire series. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getSeparator() / ChartDataLabel.setSeparator(java.lang.String) property.
    
    Returns:
    
    String separator used for the data labels of the entire series.
  - setSeparator
```
public void setSeparator(java.lang.String value)
```
    Sets string separator used for the data labels of the entire series. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead. Value defined for this property can be overridden for an individual data label with using the ChartDataLabel.getSeparator() / ChartDataLabel.setSeparator(java.lang.String) property.
    
    Parameters:
    
    value - String separator used for the data labels of the entire series.
  - getNumberFormat
```
public ChartNumberFormat getNumberFormat()
```
    Gets an ChartNumberFormat instance allowing to set number format for the data labels of the entire series.
    
    Returns:
    
    An ChartNumberFormat instance allowing to set number format for the data labels of the entire series.
  - isInherited
```
public boolean isInherited()
```

Class ChartDataLabelCollection

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

get

iterator

clearFormat

getCount

getShowCategoryName

setShowCategoryName

getShowBubbleSize

setShowBubbleSize

getShowLegendKey

setShowLegendKey

getShowPercentage

setShowPercentage

getShowSeriesName

setShowSeriesName

getShowValue

setShowValue

getShowLeaderLines

setShowLeaderLines

getShowDataLabelsRange

setShowDataLabelsRange

getSeparator

setSeparator

getNumberFormat

isInherited