com.aspose.cells

Class 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
 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.setCategoryNameShown(true);
     //Show the value in the DataLabels
     datalabels.setValueShown(true);
     //Not show the percentage in the DataLabels
     datalabels.setPercentageShown(false);
     //Not show the legend key.
     datalabels.setLegendKeyShown(false);
 }

Property Getters/Setters Summary
AreagetArea()
Gets the area.
booleangetAutoScaleFont()
void
setAutoScaleFont(booleanvalue)
True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()
void
setBackground(intvalue)
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()
void
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()
Gets the Line.
ChartgetChart()
intgetDefaultHeight()
Represents height of default position
intgetDefaultWidth()
Represents width of default position
intgetDefaultX()
Represents x of default position
intgetDefaultY()
Represents y of default position
FontgetFont()
Gets the font of the DataLabels;
intgetHeight()
void
setHeight(intvalue)
Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()
void
setAutomaticSize(booleanvalue)
Indicates whether the chart frame is automatic sized.
booleanisAutoText()
void
setAutoText(booleanvalue)
Indicates the text is auto generated.
booleanisBubbleSizeShown()
void
setBubbleSizeShown(booleanvalue)
Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleanisCategoryNameShown()
void
setCategoryNameShown(booleanvalue)
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.
booleanisDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisDeleted()
void
setDeleted(booleanvalue)
Indicates whether this data lables is deleted.
booleanisInnerMode()
void
setInnerMode(booleanvalue)
Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels.
booleanisLegendKeyShown()
void
setLegendKeyShown(booleanvalue)
Represents a specified chart's data label legend key display behavior.True if the data label legend key is visible.
booleanisPercentageShown()
void
setPercentageShown(booleanvalue)
Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleanisResizeShapeToFitText()
void
Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
booleanisSeriesNameShown()
void
setSeriesNameShown(booleanvalue)
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.
booleanisTextWrapped()
void
setTextWrapped(booleanvalue)
Gets or sets a value indicating whether the text is wrapped.
booleanisValueShown()
void
setValueShown(booleanvalue)
Represents a specified chart's data label values display behavior. True displays the values. False to hide.
java.lang.StringgetLinkedSource()
void
setLinkedSource(java.lang.Stringvalue)
Gets and sets a reference to the worksheet.
intgetNumber()
void
setNumber(intvalue)
Gets ans sets the built-in _number format.
java.lang.StringgetNumberFormat()
void
setNumberFormat(java.lang.Stringvalue)
Represents the format string for the DataLabels object.
booleangetNumberFormatLinked()
void
setNumberFormatLinked(booleanvalue)
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).
intgetPosition()
void
setPosition(intvalue)
Represents the position of the data lable. The value of the property is LabelPositionType integer constant.
intgetRotationAngle()
void
Represents text rotation angle.
intgetSeparator()
void
setSeparator(intvalue)
Sets or returns the _separator type used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.
java.lang.StringgetSeparatorValue()
void
setSeparatorValue(java.lang.Stringvalue)
Sets or returns the _separator value used for the data labels on a chart.
booleangetShadow()
void
setShadow(booleanvalue)
True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()
Gets the ShapeProperties object.
intgetShapeType()
void
setShapeType(intvalue)
Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
booleangetShowBubbleSize()
void
setShowBubbleSize(booleanvalue)
Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleangetShowCategoryName()
void
setShowCategoryName(booleanvalue)
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.
booleangetShowCellRange()
void
setShowCellRange(booleanvalue)
Indicates whether showing cell range as the data labels.
booleangetShowLegendKey()
void
setShowLegendKey(booleanvalue)
Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
booleangetShowPercentage()
void
setShowPercentage(booleanvalue)
Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleangetShowSeriesName()
void
setShowSeriesName(booleanvalue)
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.
booleangetShowValue()
void
setShowValue(booleanvalue)
Represents a specified chart's data label values display behavior. True displays the values. False to hide.
java.lang.StringgetText()
void
setText(java.lang.Stringvalue)
Gets or sets the text of a frame's title.
intgetTextDirection()
void
Represents text reading order. The value of the property is TextDirectionType integer constant.
FontgetTextFont()
Gets a Font object of the specified ChartFrame object.
intgetTextHorizontalAlignment()
void
Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()
void
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
intgetWidth()
void
setWidth(intvalue)
Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()
void
setX(intvalue)
Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()
void
setY(intvalue)
Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
FontSettingcharacters(intstartIndex, intlength)
Returns a Characters object that represents a range of characters within the text.
voidsetPositionAuto()
Set position of the frame to automatic
 

    • Property Getters/Setters Detail

      • isAutoText/setAutoText

        public boolean isAutoText() / public void setAutoText(boolean value)
        
        Indicates the text is auto generated.
      • getText/setText

        public java.lang.String getText() / public void setText(java.lang.String value)
        
        Gets or sets the text of a frame's title.
      • isTextWrapped/setTextWrapped

        public boolean isTextWrapped() / public void setTextWrapped(boolean value)
        
        Gets or sets a value indicating whether the text is wrapped.
      • getBackgroundMode/setBackgroundMode

        public int getBackgroundMode() / public void setBackgroundMode(int value)
        
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
      • isValueShown/setValueShown

        public boolean isValueShown() / public void setValueShown(boolean value)
        
        Represents a specified chart's data label values display behavior. True displays the values. False to hide. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowValue property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getShowValue/setShowValue

        public boolean getShowValue() / public void setShowValue(boolean value)
        
        Represents a specified chart's data label values display behavior. True displays the values. False to hide.
      • getShowCellRange/setShowCellRange

        public boolean getShowCellRange() / public void setShowCellRange(boolean value)
        
        Indicates whether showing cell range as the data labels.
      • isPercentageShown/setPercentageShown

        public boolean isPercentageShown() / public void setPercentageShown(boolean value)
        
        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowPercentage property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getShowPercentage/setShowPercentage

        public boolean getShowPercentage() / public void setShowPercentage(boolean value)
        
        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
      • isBubbleSizeShown/setBubbleSizeShown

        public boolean isBubbleSizeShown() / public void setBubbleSizeShown(boolean value)
        
        Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowBubbleSize property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getShowBubbleSize/setShowBubbleSize

        public boolean getShowBubbleSize() / 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/setShowCategoryName

        public boolean getShowCategoryName() / 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.
      • isCategoryNameShown/setCategoryNameShown

        public boolean isCategoryNameShown() / public void setCategoryNameShown(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. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowCategoryName property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • isSeriesNameShown/setSeriesNameShown

        public boolean isSeriesNameShown() / public void setSeriesNameShown(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. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowSeriesName property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getShowSeriesName/setShowSeriesName

        public boolean getShowSeriesName() / public 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.
      • isLegendKeyShown/setLegendKeyShown

        public boolean isLegendKeyShown() / public void setLegendKeyShown(boolean value)
        
        Represents a specified chart's data label legend key display behavior.True if the data label legend key is visible. NOTE: This member is now obsolete. Instead, please use DataLabels.ShowLegendKey property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.
      • getShowLegendKey/setShowLegendKey

        public boolean getShowLegendKey() / 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/setNumberFormat

        public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value)
        
        Represents the format string for the DataLabels object.
      • getNumber/setNumber

        public int getNumber() / public void setNumber(int value)
        
        Gets ans sets the built-in _number format.
      • getNumberFormatLinked/setNumberFormatLinked

        public boolean getNumberFormatLinked() / 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).
      • getFont

        public Font getFont()
        
        Gets the font of the DataLabels;
      • getSeparator/setSeparator

        public int getSeparator() / public void setSeparator(int value)
        
        Sets or returns the _separator type used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant. Sets _separator type will specify standard _separator for datalabels. Space is " " Comma is ", " Semicolon is "; " Period is ". " NewLine is "\n" If want set standard _separator, may sets _separator tyep to InnerCustom and set SepartorValue at the same time.
      • getSeparatorValue/setSeparatorValue

        public java.lang.String getSeparatorValue() / public void setSeparatorValue(java.lang.String value)
        
        Sets or returns the _separator value used for the data labels on a chart.
      • getPosition/setPosition

        public int getPosition() / public void setPosition(int value)
        
        Represents the position of the data lable. The value of the property is LabelPositionType integer constant.
      • getShapeType/setShapeType

        public int getShapeType() / public void setShapeType(int value)
        
        Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
      • isDeleted/setDeleted

        public boolean isDeleted() / public void setDeleted(boolean value)
        
        Indicates whether this data lables is deleted.
      • getTextHorizontalAlignment/setTextHorizontalAlignment

        public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
        
        Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
      • getTextVerticalAlignment/setTextVerticalAlignment

        public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
        
        Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
      • getRotationAngle/setRotationAngle

        public int getRotationAngle() / public void setRotationAngle(int value)
        
        Represents text rotation angle.
        0: Not rotated.

        255: Top to Bottom.

        -90: Downward.

        90: Upward.
      • getLinkedSource/setLinkedSource

        public java.lang.String getLinkedSource() / public void setLinkedSource(java.lang.String value)
        
        Gets and sets a reference to the worksheet.
      • getTextDirection/setTextDirection

        public int getTextDirection() / public void setTextDirection(int value)
        
        Represents text reading order. The value of the property is TextDirectionType integer constant.
      • isResizeShapeToFitText/setResizeShapeToFitText

        public boolean isResizeShapeToFitText() / public void setResizeShapeToFitText(boolean value)
        
        Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
      • isInnerMode/setInnerMode

        public boolean isInnerMode() / public void setInnerMode(boolean value)
        
        Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the size shall determine the size of the plot area, the tick marks, and the axis labels. Only for Xlsx file.
      • getChart

        public Chart getChart()
        
      • getBorder

        public Line getBorder()
        
        Gets the Line.
      • getArea

        public Area getArea()
        
        Gets the area.
      • getTextFont

        public Font getTextFont()
        
        Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame.Font property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
      • getAutoScaleFont/setAutoScaleFont

        public boolean getAutoScaleFont() / public void setAutoScaleFont(boolean value)
        
        True if the text in the object changes font size when the object size changes. The default value is True.
      • getBackground/setBackground

        public int getBackground() / public void setBackground(int value)
        
        Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.NOTE: This member is now obsolete. Instead, please use ChartFrame.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.
      • isAutomaticSize/setAutomaticSize

        public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
        
        Indicates whether the chart frame is automatic sized.
      • getX/setX

        public int getX() / public void setX(int value)
        
        Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? X In Pixels = X * Chart.ChartObject.Width / 4000;
      • getY/setY

        public int getY() / public void setY(int value)
        
        Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Y In Pixels = Y * Chart.ChartObject.Height / 4000;
      • getHeight/setHeight

        public int getHeight() / public void setHeight(int value)
        
        Gets or sets the height of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Height In Pixels = Y * Chart.ChartObject.Height / 4000;
      • getWidth/setWidth

        public int getWidth() / public void setWidth(int value)
        
        Gets or sets the width of frame in units of 1/4000 of the chart area. How to convert units of 1/4000 to pixels? Width In Pixels = Width * Chart.ChartObject.Height / 4000;
      • getShadow/setShadow

        public boolean getShadow() / public void setShadow(boolean value)
        
        True if the frame has a shadow.
      • isDefaultPosBeSet

        public boolean isDefaultPosBeSet()
        
        Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
      • getDefaultX

        public int getDefaultX()
        
        Represents x of default position
      • getDefaultY

        public int getDefaultY()
        
        Represents y of default position
      • getDefaultWidth

        public int getDefaultWidth()
        
        Represents width of default position
      • getDefaultHeight

        public int getDefaultHeight()
        
        Represents height of default position
    • Method Detail

      • characters

        public FontSetting characters(int startIndex, int length)
        Returns a Characters object that represents a range of characters within the text.
        Parameters:
        startIndex - The index of the start of the character.
        length - The number of characters.
        Returns:
        Characters object.
      • setPositionAuto

        public void setPositionAuto()
        Set position of the frame to automatic