ChartDataLabel (Aspose.Words for Java API Reference)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public class ChartDataLabel
extends java.lang.Object
implements java.lang.Cloneable
```
Represents data label on a chart point or trendline.
To learn more, visit the Working with Charts documentation article.
On a series, the ChartDataLabel object is a member of the ChartDataLabelCollection. The ChartDataLabelCollection contains a ChartDataLabel object for each point.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearFormat()` Clears format of this data label.
`int`	`getIndex()` Specifies the index of the containing element.
`ChartNumberFormat`	`getNumberFormat()` Returns number format of the parent element.
`java.lang.String`	`getSeparator()` Gets string separator used for the data labels on a chart.
`boolean`	`getShowBubbleSize()` Allows to specify if bubble size is to be displayed for the data labels on a chart.
`boolean`	`getShowCategoryName()` Allows to specify if category name is to be displayed for the data labels on a chart.
`boolean`	`getShowDataLabelsRange()` Allows to specify if values from data labels range to be displayed in the data labels.
`boolean`	`getShowLeaderLines()` Allows to specify if data label leader lines need be shown.
`boolean`	`getShowLegendKey()` Allows to specify if legend key is to be displayed for the data labels on a chart.
`boolean`	`getShowPercentage()` Allows to specify if percentage value is to be displayed for the data labels on a chart.
`boolean`	`getShowSeriesName()` Gets a Boolean to indicate the series name display behavior for the data labels on a chart.
`boolean`	`getShowValue()` Allows to specify if values are to be displayed in the data labels.
`boolean`	`isHidden()` Gets/sets a flag indicating whether this label is hidden.
`void`	`isHidden(boolean value)` Gets/sets a flag indicating whether this label is hidden.
`boolean`	`isInherited()`
`boolean`	`isVisible()` Returns true if this data label has something to display.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`setSeparator(java.lang.String value)` Sets string separator used for the data labels on a chart.
`void`	`setShowBubbleSize(boolean value)` Allows to specify if bubble size is to be displayed for the data labels on a chart.
`void`	`setShowCategoryName(boolean value)` Allows to specify if category name is to be displayed for the data labels on a chart.
`void`	`setShowDataLabelsRange(boolean value)` Allows to specify if values from data labels range to be displayed in the data labels.
`void`	`setShowLeaderLines(boolean value)` Allows to specify if data label leader lines need be shown.
`void`	`setShowLegendKey(boolean value)` Allows to specify if legend key is to be displayed for the data labels on a chart.
`void`	`setShowPercentage(boolean value)` Allows to specify if percentage value is to be displayed for the data labels on a chart.
`void`	`setShowSeriesName(boolean value)` Sets a Boolean to indicate the series name display behavior for the data labels on a chart.
`void`	`setShowValue(boolean value)` Allows to specify if values are to be displayed in the data labels.

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

- Method Detail
  - clearFormat
```
public void clearFormat()
```
    Clears format of this data label. The properties are set to the default values defined in the parent data label collection.
  - getIndex
```
public int getIndex()
```
    Specifies the index of the containing element. This index shall determine which of the parent's children collection this element applies to. Default value is 0.
    
    Returns:
    
    The corresponding int value.
  - getShowCategoryName
```
public boolean getShowCategoryName()
```
    Allows to specify if category name is to be displayed for the data labels on a chart. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowCategoryName
```
public void setShowCategoryName(boolean value)
```
    Allows to specify if category name is to be displayed for the data labels on a chart. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowBubbleSize
```
public boolean getShowBubbleSize()
```
    Allows to specify if bubble size is to be displayed for the data labels on a chart. Applies only to Bubble charts. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowBubbleSize
```
public void setShowBubbleSize(boolean value)
```
    Allows to specify if bubble size is to be displayed for the data labels on a chart. Applies only to Bubble charts. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowLegendKey
```
public boolean getShowLegendKey()
```
    Allows to specify if legend key is to be displayed for the data labels on a chart. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowLegendKey
```
public void setShowLegendKey(boolean value)
```
    Allows to specify if legend key is to be displayed for the data labels on a chart. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowPercentage
```
public boolean getShowPercentage()
```
    Allows to specify if percentage value is to be displayed for the data labels on a chart. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowPercentage
```
public void setShowPercentage(boolean value)
```
    Allows to specify if percentage value is to be displayed for the data labels on a chart. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowSeriesName
```
public boolean getShowSeriesName()
```
    Gets 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. By default false.
    
    Returns:
    
    A Boolean to indicate the series name display behavior for the data labels on a chart.
  - setShowSeriesName
```
public void setShowSeriesName(boolean value)
```
    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. By default false.
    
    Parameters:
    
    value - A Boolean to indicate the series name display behavior for the data labels on a chart.
  - getShowValue
```
public boolean getShowValue()
```
    Allows to specify if values are to be displayed in the data labels. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowValue
```
public void setShowValue(boolean value)
```
    Allows to specify if values are to be displayed in the data labels. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowLeaderLines
```
public boolean getShowLeaderLines()
```
    Allows to specify if data label leader lines need be shown. Default value is false. Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.
    
    Returns:
    
    The corresponding boolean value.
  - setShowLeaderLines
```
public void setShowLeaderLines(boolean value)
```
    Allows to specify if data label leader lines need be shown. Default value is false. Applies to Pie charts only. Leader lines create a visual connection between a data label and its corresponding data point.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getShowDataLabelsRange
```
public boolean getShowDataLabelsRange()
```
    Allows to specify if values from data labels range to be displayed in the data labels. Default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setShowDataLabelsRange
```
public void setShowDataLabelsRange(boolean value)
```
    Allows to specify if values from data labels range to be displayed in the data labels. Default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getSeparator
```
public java.lang.String getSeparator()
```
    Gets string separator used for the data labels on a chart. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.
    
    Returns:
    
    String separator used for the data labels on a chart.
  - setSeparator
```
public void setSeparator(java.lang.String value)
```
    Sets string separator used for the data labels on a chart. The default is a comma, except for pie charts showing only category name and percentage, when a line break shall be used instead.
    
    Parameters:
    
    value - String separator used for the data labels on a chart.
  - isVisible
```
public boolean isVisible()
```
    Returns true if this data label has something to display.
    
    Returns:
    
    True if this data label has something to display.
  - getNumberFormat
```
public ChartNumberFormat getNumberFormat()
```
    Returns number format of the parent element.
    
    Returns:
    
    Number format of the parent element.
  - isHidden
```
public boolean isHidden()
```
    Gets/sets a flag indicating whether this label is hidden. The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - isHidden
```
public void isHidden(boolean value)
```
    Gets/sets a flag indicating whether this label is hidden. The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - isInherited
```
public boolean isInherited()
```
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class ChartDataLabel

Method Summary

Methods inherited from class java.lang.Object

Method Detail

clearFormat

getIndex

getShowCategoryName

setShowCategoryName

getShowBubbleSize

setShowBubbleSize

getShowLegendKey

setShowLegendKey

getShowPercentage

setShowPercentage

getShowSeriesName

setShowSeriesName

getShowValue

setShowValue

getShowLeaderLines

setShowLeaderLines

getShowDataLabelsRange

setShowDataLabelsRange

getSeparator

setSeparator

isVisible

getNumberFormat

isHidden

isHidden

isInherited

memberwiseClone