Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class DataLabels

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

public class DataLabels
extends java.lang.Object

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


Method Summary
 Area getArea()
          Gets the Area.
 Line getBorder()
          Gets the border Line.
 Font getFont()
          Gets a Font object of the chart data label.
 byte getLabelPosition()
          Gets the lable position.
 int getNumber()
          Gets the built-in display format of numbers and dates.
 int getTextHorizontalAlignment()
          Gets the text horizontal alignment.
 int getTextVerticalAlignment()
          Gets the text vertical alignment of text.
 boolean isBubbleShown()
          Indicates whether the chart's data label Percentage display.
 boolean isCategoryNameShown()
          Indicates whether the chart's data label category name display.
 boolean isPercentageShown()
          Indicates whether the chart's data label Percentage display.
 boolean isSeriesShown()
          Indicates whether chart's data label series names display.
 boolean isValueShown()
          Indicates whether the chart's data label values display.
 void setBubbleShown(boolean isBubbleShown)
          Sets whether the chart's data label Percentage display.
 void setCategoryNameShown(boolean isCategoryNameShown)
          Sets whether the chart's data label category name display.
 void setFont(Font font)
          Sets a Font object of the chart data label.
 void setLabelPosition(byte LablePositionType)
          Sets the label postion.
 void setNumber(int number)
          Sets the built-in display format of numbers and dates.
Use built-in numbers for better performance.
 void setPercentageShown(boolean isPercentageShown)
          Sets whether the chart's data label Percentage display.
 void setSeriesShown(boolean isSeriesShown)
          Sets whether chart's data label series names display.
 void setTextHorizontalAlignment(int textAlignmentType)
          Sets the text horizontal alignment.
 void setTextVerticalAlignment(int textAlignmentType)
          Sets the text vertical alignment of text.
 void setValueShown(boolean isValueShown)
          Sets whether the chart's data label values display.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getFont

public Font getFont()
Gets a Font object of the chart data label.

Returns:
a Font object of the chart data label.
Throws:
CellsException - if series has bean removed.

setFont

public void setFont(Font font)
Sets a Font object of the chart data label.

Parameters:
font - a Font object of the chart data label.
Throws:
CellsException - if series has bean removed.

setSeriesShown

public void setSeriesShown(boolean isSeriesShown)
Sets whether chart's data label series names display.

Parameters:
isSeriesShown - whether chart's data label series names display.
Throws:
CellsException - if the series has bean removed.

isSeriesShown

public boolean isSeriesShown()
Indicates whether chart's data label series names display. True if the data label series names is visible.

Returns:
whether chart's data label series names display.
Throws:
CellsException - if the series has bean removed.

setValueShown

public void setValueShown(boolean isValueShown)
Sets whether the chart's data label values display. True displays the values. False to hide.

Parameters:
isValueShown - whether the chart's data label values display.
Throws:
CellsException - if the series has bean removed.

isValueShown

public boolean isValueShown()
Indicates whether the chart's data label values display. True displays the values. False to hide.

Returns:
whether the chart's data label values display.
Throws:
CellsException - if the series has bean removed.

setCategoryNameShown

public void setCategoryNameShown(boolean isCategoryNameShown)
Sets whether the chart's data label category name display. True to display the category name for the data labels on a chart. False to hide.

Parameters:
isCategoryNameShown - whether the chart's data label category name display.
Throws:
CellsException - if the series has bean removed.

isCategoryNameShown

public boolean isCategoryNameShown()
Indicates whether the chart's data label category name display. True to display the category name for the data labels on a chart. False to hide.

Returns:
whether the chart's data label category name display.
Throws:
CellsException - if the series has bean removed.

isPercentageShown

public boolean isPercentageShown()
Indicates whether the chart's data label Percentage display. True to display the Percentage for the data labels on a chart. False to hide.

Returns:
whether the chart's data label Percentage display.
Throws:
CellsException - if the series has bean removed.

setPercentageShown

public void setPercentageShown(boolean isPercentageShown)
Sets whether the chart's data label Percentage display. True to display the Percentage for the data labels on a chart. False to hide.

Parameters:
isPercentageShown - whether the chart's data label Percentage display.
Throws:
CellsException - if the series has bean removed.

isBubbleShown

public boolean isBubbleShown()
Indicates whether the chart's data label Percentage display. True to display the Percentage for the data labels on a chart. False to hide.

Returns:
whether the chart's data label Percentage display.
Throws:
CellsException - if the series has bean removed.

setBubbleShown

public void setBubbleShown(boolean isBubbleShown)
Sets whether the chart's data label Percentage display. True to display the Percentage for the data labels on a chart. False to hide.

Parameters:
isBubbleShown - whether the chart's data label Percentage display.
Throws:
CellsException - if the series has bean removed.

getTextHorizontalAlignment

public int getTextHorizontalAlignment()
Gets the text horizontal alignment.

Returns:
the text horizontal alignment.
Throws:
CellsException - if chart has bean removed.
See Also:
setTextHorizontalAlignment(int)

setTextHorizontalAlignment

public void setTextHorizontalAlignment(int textAlignmentType)
Sets the text horizontal alignment.

Parameters:
textAlignmentType - the text horizontal alignment. It could be one of the following values:
TextAlignmentType.LEFT
TextAlignmentType.CENTER
TextAlignmentType.RIGHT
TextAlignmentType.JUSTIFY
TextAlignmentType.DISTRIBUTED
Throws:
CellsException - if chart has bean removed.
java.lang.IllegalArgumentException - if test alignment type is invalid.

getLabelPosition

public byte getLabelPosition()
Gets the lable position.

Returns:
the lable position.

setLabelPosition

public void setLabelPosition(byte LablePositionType)
Sets the label postion.

Parameters:
LablePositionType - the label postion. It must be the const number of LabelPositionType.
See Also:
LabelPositionType

getTextVerticalAlignment

public int getTextVerticalAlignment()
Gets the text vertical alignment of text.

Returns:
the text vertical alignment of text.
Throws:
CellsException - if chart has bean removed.
See Also:
setTextVerticalAlignment(int)

setTextVerticalAlignment

public void setTextVerticalAlignment(int textAlignmentType)
Sets the text vertical alignment of text.

Parameters:
textAlignmentType - the text vertical alignment of text. * It could be one of the following values:
TextAlignmentType.TOP
TextAlignmentType.CENTER
TextAlignmentType.BOTTOM
TextAlignmentType.JUSTIFY
TextAlignmentType.DISTRIBUTED
Throws:
CellsException - if chart has bean removed.
java.lang.IllegalArgumentException - if test alignment type is invalid.

setNumber

public void setNumber(int number)
Sets the built-in display format of numbers and dates.
Use built-in numbers for better performance.

Parameters:
number - the built-in formatting number.
Throws:
java.lang.IllegalArgumentException - if number is invalid.
CellsException - if the series has bean removed.
See Also:
Style.setNumber(int)

getNumber

public int getNumber()
Gets the built-in display format of numbers and dates.

Returns:
the built-in formatting number.
Throws:
CellsException - if the series has bean removed.
See Also:
Style.setNumber(int)

getBorder

public Line getBorder()
Gets the border Line.

Returns:
the border Line.
Throws:
CellsException - if chart has bean removed.

getArea

public Area getArea()
Gets the Area.

Returns:
the Area.
Throws:
CellsException - if chart has bean removed.