com.aspose.cells
Class DataLabels

java.lang.Object
  extended by ChartFrame
      extended by com.aspose.cells.DataLabels

public class DataLabels 
extends ChartFrame

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()→ inherited from ChartFrame
           Gets the area.
booleangetAutoScaleFont()→ inherited from ChartFrame
voidsetAutoScaleFont(boolean value)
           True if the text in the object changes font size when the object size changes. The default value is True.
intgetBackground()
voidsetBackground(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
intgetBackgroundMode()
voidsetBackgroundMode(int value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
LinegetBorder()→ inherited from ChartFrame
           Gets the Line.
ChartgetChart()→ inherited from ChartFrame
          
intgetDefaultHeight()→ inherited from ChartFrame
           Represents height of default position
intgetDefaultWidth()→ inherited from ChartFrame
           Represents width of default position
intgetDefaultX()→ inherited from ChartFrame
           Represents x of default position
intgetDefaultY()→ inherited from ChartFrame
           Represents y of default position
FontgetFont()
           Gets the font of the DataLabels;
intgetHeight()→ inherited from ChartFrame
voidsetHeight(int value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
booleanisAutomaticSize()→ inherited from ChartFrame
voidsetAutomaticSize(boolean value)
           Indicates whether the chart frame is automatic sized.
booleanisAutoText()
voidsetAutoText(boolean value)
           Indicates the text is auto generated.
booleanisBubbleSizeShown()
voidsetBubbleSizeShown(boolean value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleanisCategoryNameShown()
voidsetCategoryNameShown(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.
booleanisDefaultPosBeSet()→ inherited from ChartFrame
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
booleanisDeleted()
voidsetDeleted(boolean value)
           Indicates whether this data lables is deleted.
booleanisInnerMode()→ inherited from ChartFrame
voidsetInnerMode(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.
booleanisLegendKeyShown()
voidsetLegendKeyShown(boolean value)
           Represents a specified chart's data label legend key display behavior.True if the data label legend key is visible.
booleanisPercentageShown()
voidsetPercentageShown(boolean value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleanisSeriesNameShown()
voidsetSeriesNameShown(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.
booleanisValueShown()
voidsetValueShown(boolean value)
           Represents a specified chart's data label values display behavior. True displays the values. False to hide.
java.lang.StringgetLinkedSource()
voidsetLinkedSource(java.lang.String value)
           Gets and sets a reference to the worksheet.
intgetNumber()
voidsetNumber(int value)
           Gets ans sets the built-in number format.
java.lang.StringgetNumberFormat()
voidsetNumberFormat(java.lang.String value)
           Represents the format string for the DataLabels object.
booleangetNumberFormatLinked()
voidsetNumberFormatLinked(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).
intgetPosition()
voidsetPosition(int value)
           Represents the position of the data lable. The value of the property is LabelPositionType integer constant.
intgetPostion()
voidsetPostion(int value)
           Represents the position of the data lable. The value of the property is LabelPositionType integer constant.
intgetRotation()
voidsetRotation(int value)
           Represents text rotation angle.
intgetRotationAngle()
voidsetRotationAngle(int value)
           Represents text rotation angle.
intgetSeparator()
voidsetSeparator(int value)
           Sets or returns a Variant representing the separator used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.
booleangetShadow()→ inherited from ChartFrame
voidsetShadow(boolean value)
           True if the frame has a shadow.
ShapePropertyCollectiongetShapeProperties()→ inherited from ChartFrame
           Gets the ShapeProperties object.
booleangetShowBubbleSize()
voidsetShowBubbleSize(boolean value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleangetShowCategoryName()
voidsetShowCategoryName(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.
booleangetShowLegendKey()
voidsetShowLegendKey(boolean value)
           Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
booleangetShowPercentage()
voidsetShowPercentage(boolean value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
booleangetShowSeriesName()
voidsetShowSeriesName(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.
booleangetShowValue()
voidsetShowValue(boolean value)
           Represents a specified chart's data label values display behavior. True displays the values. False to hide.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text of a frame's title.
intgetTextDirection()
voidsetTextDirection(int value)
           Represents text reading order. The value of the property is TextDirectionType integer constant.
FontgetTextFont()→ inherited from ChartFrame
           Gets a Font object of the specified ChartFrame object.
intgetTextHorizontalAlignment()
voidsetTextHorizontalAlignment(int value)
           Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalAlignment()
voidsetTextVerticalAlignment(int value)
           Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
intgetWidth()→ inherited from ChartFrame
voidsetWidth(int value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
intgetX()→ inherited from ChartFrame
voidsetX(int value)
           Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
intgetY()→ inherited from ChartFrame
voidsetY(int value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 

Property Getters/Setters Detail

isAutoText/setAutoText

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

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.

getRotation/setRotation

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

255: Top to Bottom.

-90: Downward.

90: Upward.
NOTE: This member is now obsolete. Instead, please use DataLabels.RotationAngle property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

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.

getText/setText

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

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.

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 DataLabels.BackgroundMode property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

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.

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 a Variant representing the separator used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.

getPostion/setPostion

public int getPostion() / public void setPostion(int value)
Represents the position of the data lable. The value of the property is LabelPositionType integer constant.This property will be removed 12 months later since October 2008. Aspose apologizes for any inconvenience you may have experienced.

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.

isInnerMode/setInnerMode

→ inherited from ChartFrame
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

→ inherited from ChartFrame
public Chart getChart()

getBorder

→ inherited from ChartFrame
public Line getBorder()
Gets the Line.

getArea

→ inherited from ChartFrame
public Area getArea()
Gets the area.

getTextFont

→ inherited from ChartFrame
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

→ inherited from ChartFrame
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.

isAutomaticSize/setAutomaticSize

→ inherited from ChartFrame
public boolean isAutomaticSize() / public void setAutomaticSize(boolean value)
Indicates whether the chart frame is automatic sized.

getX/setX

→ inherited from ChartFrame
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

→ inherited from ChartFrame
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

→ inherited from ChartFrame
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

→ inherited from ChartFrame
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

→ inherited from ChartFrame
public boolean getShadow() / public void setShadow(boolean value)
True if the frame has a shadow.

getShapeProperties

→ inherited from ChartFrame
public ShapePropertyCollection getShapeProperties()
Gets the ShapeProperties object.

isDefaultPosBeSet

→ inherited from ChartFrame
public boolean isDefaultPosBeSet()
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.

getDefaultX

→ inherited from ChartFrame
public int getDefaultX()
Represents x of default position

getDefaultY

→ inherited from ChartFrame
public int getDefaultY()
Represents y of default position

getDefaultWidth

→ inherited from ChartFrame
public int getDefaultWidth()
Represents width of default position

getDefaultHeight

→ inherited from ChartFrame
public int getDefaultHeight()
Represents height of default position

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.