DataLabels (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.ChartFrame
- - com.aspose.cells.ChartTextFrame
  - - com.aspose.cells.DataLabels

public class DataLabels
extends ChartTextFrame

Encapsulates a collection of all the DataLabel objects for the specified Series.

Example

 
         //Set the DataLabels in the chart
         Workbook wb = new Workbook("chart.xlsx");
         Chart chart = wb.getWorksheets().get(0).getCharts().get(0);
         DataLabels datalabels;
         for (int i = 0; i  <chart.getNSeries().getCount(); i++)
         {
             datalabels = chart.getNSeries().get(i).getDataLabels();
             //Set the position of DataLabels
             datalabels.setPosition(LabelPositionType.INSIDE_BASE);
             //Show the category name in the DataLabels
             datalabels.setShowCategoryName(true);
             //Show the value in the DataLabels
             datalabels.setShowValue(true);
             //Not show the percentage in the DataLabels
             datalabels.setShowPercentage(false);
             //Not show the legend key.
             datalabels.setShowLegendKey(false);
         }

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyFont()` Apply the font of the datalabels to all child nodes.
`Area`	`getArea()` Gets the `Area`.
`int`	`getBackgroundMode()` Gets the display mode of the background
`Line`	`getBorder()` Gets the `Line`.
`int`	`getDirectionType()` Gets the direction of text.
`Font`	`getFont()` Gets the font of the DataLabels;
`int`	`getNumber()` Gets the built-in number format.
`java.lang.String`	`getNumberFormat()` Represents the format string for the DataLabels object.
`boolean`	`getNumberFormatLinked()` True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
`int`	`getPosition()` Represents the position of the data label.
`int`	`getSeparatorType()` Gets the separator type used for the data labels on a chart.
`java.lang.String`	`getSeparatorValue()` Gets the separator value used for the data labels on a chart.
`int`	`getShapeType()` Gets shape type of data label.
`boolean`	`getShowBubbleSize()` Represents a specified chart's data label percentage value display behavior.
`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.
`boolean`	`getShowCellRange()` Indicates whether showing cell range as the data labels.
`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()` Indicates whether the series name displays for the data labels on a chart.
`boolean`	`getShowValue()` Represents a specified chart's data label values display behavior.
`java.lang.String`	`getText()` Gets the text of data label.
`boolean`	`isAutoText()` Indicates the text is auto generated.
`boolean`	`isNeverOverlap()` Indicates whether the datalabels display never overlap.
`boolean`	`isTextWrapped()` Gets a value indicating whether the text is wrapped.
`void`	`setAutoText(boolean value)` Indicates the text is auto generated.
`void`	`setBackgroundMode(int value)` Sets the display mode of the background
`void`	`setDirectionType(int value)` Sets the direction of text.
`void`	`setNeverOverlap(boolean value)` Indicates whether the datalabels display never overlap.
`void`	`setNumber(int value)` Sets the built-in number format.
`void`	`setNumberFormat(java.lang.String value)` Represents the format string for the DataLabels object.
`void`	`setNumberFormatLinked(boolean value)` True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
`void`	`setPosition(int value)` Represents the position of the data label.
`void`	`setSeparatorType(int value)` Sets the separator type used for the data labels on a chart.
`void`	`setSeparatorValue(java.lang.String value)` Sets the separator value used for the data labels on a chart.
`void`	`setShapeType(int value)` Sets shape type of data label.
`void`	`setShowBubbleSize(boolean value)` Represents a specified chart's data label percentage value display behavior.
`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.
`void`	`setShowCellRange(boolean value)` Indicates whether showing cell range as the data labels.
`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)` Indicates whether the series name displays for the data labels on a chart.
`void`	`setShowValue(boolean value)` Represents a specified chart's data label values display behavior.
`void`	`setText(java.lang.String value)` Sets the text of data label.
`void`	`setTextWrapped(boolean value)` Sets a value indicating whether the text is wrapped.

Methods inherited from class com.aspose.cells.ChartTextFrame
characters, getLinkedSource, getReadingOrder, getRotationAngle, getTextDirection, getTextHorizontalAlignment, getTextVerticalAlignment, isAutomaticRotation, isDeleted, isResizeShapeToFitText, setDeleted, setLinkedSource, setReadingOrder, setResizeShapeToFitText, setRotationAngle, setTextDirection, setTextHorizontalAlignment, setTextVerticalAlignment

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

- Method Detail
  - getBorder
```
public Line getBorder()
```
    Gets the Line.
    
    Overrides:
    
    getBorder in class ChartFrame
  - getArea
```
public Area getArea()
```
    Gets the Area.
    
    Overrides:
    
    getArea in class ChartFrame
  - isAutoText
```
public boolean isAutoText()
```
    Indicates the text is auto generated.
    
    Overrides:
    
    isAutoText in class ChartTextFrame
  - setAutoText
```
public void setAutoText(boolean value)
```
    Indicates the text is auto generated.
    
    Overrides:
    
    setAutoText in class ChartTextFrame
  - getDirectionType
```
public int getDirectionType()
```
    Gets the direction of text.
    See ChartTextDirectionType.
    
    Overrides:
    
    getDirectionType in class ChartTextFrame
  - setDirectionType
```
public void setDirectionType(int value)
```
    Sets the direction of text.
    See ChartTextDirectionType.
    
    Overrides:
    
    setDirectionType in class ChartTextFrame
  - getText
```
public java.lang.String getText()
```
    Gets the text of data label.
    
    Overrides:
    
    getText in class ChartTextFrame
  - setText
```
public void setText(java.lang.String value)
```
    Sets the text of data label.
    
    Overrides:
    
    setText in class ChartTextFrame
  - isTextWrapped
```
public boolean isTextWrapped()
```
    Gets a value indicating whether the text is wrapped.
    
    Overrides:
    
    isTextWrapped in class ChartTextFrame
  - setTextWrapped
```
public void setTextWrapped(boolean value)
```
    Sets a value indicating whether the text is wrapped.
    
    Overrides:
    
    setTextWrapped in class ChartTextFrame
  - getBackgroundMode
```
public int getBackgroundMode()
```
    Gets the display mode of the background
    See BackgroundMode.
    
    Overrides:
    
    getBackgroundMode in class ChartFrame
  - setBackgroundMode
```
public void setBackgroundMode(int value)
```
    Sets the display mode of the background
    See BackgroundMode.
    
    Overrides:
    
    setBackgroundMode in class ChartFrame
  - getShowValue
```
public boolean getShowValue()
```
    Represents a specified chart's data label values display behavior. True displays the values. False to hide.
  - setShowValue
```
public void setShowValue(boolean value)
```
    Represents a specified chart's data label values display behavior. True displays the values. False to hide.
  - getShowCellRange
```
public boolean getShowCellRange()
```
    Indicates whether showing cell range as the data labels.
  - setShowCellRange
```
public void setShowCellRange(boolean value)
```
    Indicates whether showing cell range as the data labels.
  - getShowPercentage
```
public boolean getShowPercentage()
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - setShowPercentage
```
public void setShowPercentage(boolean value)
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - getShowBubbleSize
```
public boolean getShowBubbleSize()
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - setShowBubbleSize
```
public void setShowBubbleSize(boolean value)
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - getShowCategoryName
```
public 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.
  - setShowCategoryName
```
public 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.
  - getShowSeriesName
```
public boolean getShowSeriesName()
```
    Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
  - setShowSeriesName
```
public void setShowSeriesName(boolean value)
```
    Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
  - getShowLegendKey
```
public boolean getShowLegendKey()
```
    Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
  - setShowLegendKey
```
public void setShowLegendKey(boolean value)
```
    Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
  - getNumberFormat
```
public java.lang.String getNumberFormat()
```
    Represents the format string for the DataLabels object.
  - setNumberFormat
```
public void setNumberFormat(java.lang.String value)
```
    Represents the format string for the DataLabels object.
  - getNumber
```
public int getNumber()
```
    Gets the built-in number format.
  - setNumber
```
public void setNumber(int value)
```
    Sets the built-in number format.
  - getNumberFormatLinked
```
public boolean getNumberFormatLinked()
```
    True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
  - setNumberFormatLinked
```
public void setNumberFormatLinked(boolean value)
```
    True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
  - applyFont
```
public void applyFont()
```
    Apply the font of the datalabels to all child nodes.
  - getFont
```
public Font getFont()
```
    Gets the font of the DataLabels;
    
    Overrides:
    
    getFont in class ChartFrame
  - getSeparatorType
```
public int getSeparatorType()
```
    Gets the separator type used for the data labels on a chart.
    See DataLabelsSeparatorType.
    
    Remarks
    To set custom separator, please set the property getSeparatorType() as DataLabelsSeparatorType.CUSTOM and then specify the expected value for getSeparatorValue().
  - setSeparatorType
```
public void setSeparatorType(int value)
```
    Sets the separator type used for the data labels on a chart.
    See DataLabelsSeparatorType.
    
    Remarks
    To set custom separator, please set the property getSeparatorType() as DataLabelsSeparatorType.CUSTOM and then specify the expected value for getSeparatorValue().
  - getSeparatorValue
```
public java.lang.String getSeparatorValue()
```
    Gets the separator value used for the data labels on a chart.
  - setSeparatorValue
```
public void setSeparatorValue(java.lang.String value)
```
    Sets the separator value used for the data labels on a chart.
  - getPosition
```
public int getPosition()
```
    Represents the position of the data label.
    See LabelPositionType.
  - setPosition
```
public void setPosition(int value)
```
    Represents the position of the data label.
    See LabelPositionType.
  - isNeverOverlap
```
public boolean isNeverOverlap()
```
    Indicates whether the datalabels display never overlap. (For Pie chart)
  - setNeverOverlap
```
public void setNeverOverlap(boolean value)
```
    Indicates whether the datalabels display never overlap. (For Pie chart)
  - getShapeType
```
public int getShapeType()
```
    Gets shape type of data label.
    See DataLabelShapeType.
  - setShapeType
```
public void setShapeType(int value)
```
    Sets shape type of data label.
    See DataLabelShapeType.

Class DataLabels

Method Summary

Methods inherited from class com.aspose.cells.ChartTextFrame

Methods inherited from class com.aspose.cells.ChartFrame

Methods inherited from class java.lang.Object

Method Detail

getBorder

getArea

isAutoText

setAutoText

getDirectionType

setDirectionType

getText

setText

isTextWrapped

setTextWrapped

getBackgroundMode

setBackgroundMode

getShowValue

setShowValue

getShowCellRange

setShowCellRange

getShowPercentage

setShowPercentage

getShowBubbleSize

setShowBubbleSize

getShowCategoryName

setShowCategoryName

getShowSeriesName

setShowSeriesName

getShowLegendKey

setShowLegendKey

getNumberFormat

setNumberFormat

getNumber

setNumber

getNumberFormatLinked

setNumberFormatLinked

applyFont

getFont

getSeparatorType

setSeparatorType

getSeparatorValue

setSeparatorValue

getPosition

setPosition

isNeverOverlap

setNeverOverlap

getShapeType

setShapeType