asposecells.api
Class DataLabels

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

Example:

workbook = Workbook()
# Adding a new worksheet to the Excel object
sheetIndex = workbook.getWorksheets().add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
worksheet = workbook.getWorksheets().get(sheetIndex)
# Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50)
# Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100)
# Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150)
# Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(4)
# Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(20)
# Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50)
# Adding a chart to the worksheet
chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 25, 5)
# Accessing the instance of the newly added chart
chart = worksheet.getCharts().get(chartIndex)

# Set the DataLabels in the chart
for i in range(0, chart.getNSeries().getCount()):
    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
methodgetArea()
           Gets the Area.
methodgetAutoScaleFont()
methodsetAutoScaleFont(value)
           True if the text in the object changes font size when the object size changes. The default value is True.
methodgetBackground()
methodsetBackground(value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBackgroundMode()
methodsetBackgroundMode(value)
           Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
methodgetBorder()
           Gets the Line.
methodgetChart()
          
methodgetDefaultHeight()
           Represents height of default position
methodgetDefaultWidth()
           Represents width of default position
methodgetDefaultX()
           Represents x of default position
methodgetDefaultY()
           Represents y of default position
methodgetFont()
           Gets the font of the DataLabels;
methodgetHeight()
methodsetHeight(value)
           Gets or sets the height of frame in units of 1/4000 of the chart area.
methodisAutomaticSize()
methodsetAutomaticSize(value)
           Indicates whether the chart frame is automatic sized.
methodisAutoText()
methodsetAutoText(value)
           Indicates the text is auto generated.
methodisDefaultPosBeSet()
           Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
methodisDeleted()
methodsetDeleted(value)
           Indicates whether this data lables is deleted.
methodisInnerMode()
methodsetInnerMode(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.
methodisResizeShapeToFitText()
methodsetResizeShapeToFitText(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.
methodisTextWrapped()
methodsetTextWrapped(value)
           Gets or sets a value indicating whether the text is wrapped.
methodgetLinkedSource()
methodsetLinkedSource(value)
           Gets and sets a reference to the worksheet.
methodgetNumber()
methodsetNumber(value)
           Gets ans sets the built-in _number format.
methodgetNumberFormat()
methodsetNumberFormat(value)
           Represents the format string for the DataLabels object.
methodgetNumberFormatLinked()
methodsetNumberFormatLinked(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).
methodgetPosition()
methodsetPosition(value)
           Represents the position of the data lable. The value of the property is LabelPositionType integer constant.
methodgetRotationAngle()
methodsetRotationAngle(value)
           Represents text rotation angle.
methodgetSeparator()
methodsetSeparator(value)
           Sets or returns the _separator type used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.
methodgetSeparatorValue()
methodsetSeparatorValue(value)
           Sets or returns the _separator value used for the data labels on a chart.
methodgetShadow()
methodsetShadow(value)
           True if the frame has a shadow.
methodgetShapeProperties()
           Gets the ShapeProperties object.
methodgetShapeType()
methodsetShapeType(value)
           Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
methodgetShowBubbleSize()
methodsetShowBubbleSize(value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
methodgetShowCategoryName()
methodsetShowCategoryName(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.
methodgetShowCellRange()
methodsetShowCellRange(value)
           Indicates whether showing cell range as the data labels.
methodgetShowLegendKey()
methodsetShowLegendKey(value)
           Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
methodgetShowPercentage()
methodsetShowPercentage(value)
           Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
methodgetShowSeriesName()
methodsetShowSeriesName(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.
methodgetShowValue()
methodsetShowValue(value)
           Represents a specified chart's data label values display behavior. True displays the values. False to hide.
methodgetText()
methodsetText(value)
           Gets or sets the text of a frame's title.
methodgetTextDirection()
methodsetTextDirection(value)
           Represents text reading order. The value of the property is TextDirectionType integer constant.
methodgetTextFont()
           Gets a Font object of the specified ChartFrame object.
methodgetTextHorizontalAlignment()
methodsetTextHorizontalAlignment(value)
           Ges or sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
methodgetTextVerticalAlignment()
methodsetTextVerticalAlignment(value)
           Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
methodgetWidth()
methodsetWidth(value)
           Gets or sets the width of frame in units of 1/4000 of the chart area.
methodgetX()
methodsetX(value)
           Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
methodgetY()
methodsetY(value)
           Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.
 
Method Summary
methodcharacters(startIndex, length)→ inherited from ChartTextFrame
           Returns a Characters object that represents a range of characters within the text.
methodsetPositionAuto()→ inherited from ChartFrame
           Set position of the frame to automatic
 

Property Getters/Setters Detail

getBorder : Line 

Line getBorder()
Gets the Line.

getArea : Area 

Area getArea()
Gets the Area.

isAutoText/setAutoText : boolean 

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

getText/setText : String 

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

isTextWrapped/setTextWrapped : boolean 

boolean isTextWrapped() / setTextWrapped(value)
Gets or sets a value indicating whether the text is wrapped.

getBackgroundMode/setBackgroundMode : int 

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

getShowValue/setShowValue : boolean 

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

getShowCellRange/setShowCellRange : boolean 

boolean getShowCellRange() / setShowCellRange(value)
Indicates whether showing cell range as the data labels.

getShowPercentage/setShowPercentage : boolean 

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

getShowBubbleSize/setShowBubbleSize : boolean 

boolean getShowBubbleSize() / setShowBubbleSize(value)
Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.

getShowCategoryName/setShowCategoryName : boolean 

boolean getShowCategoryName() / setShowCategoryName(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/setShowSeriesName : boolean 

boolean getShowSeriesName() / setShowSeriesName(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.

getShowLegendKey/setShowLegendKey : boolean 

boolean getShowLegendKey() / setShowLegendKey(value)
Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.

getNumberFormat/setNumberFormat : String 

String getNumberFormat() / setNumberFormat(value)
Represents the format string for the DataLabels object.

getNumber/setNumber : int 

int getNumber() / setNumber(value)
Gets ans sets the built-in _number format.

getNumberFormatLinked/setNumberFormatLinked : boolean 

boolean getNumberFormatLinked() / setNumberFormatLinked(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 : Font 

Font getFont()
Gets the font of the DataLabels;

getSeparator/setSeparator : int 

int getSeparator() / setSeparator(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 : String 

String getSeparatorValue() / setSeparatorValue(value)
Sets or returns the _separator value used for the data labels on a chart.

getPosition/setPosition : int 

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

getShapeType/setShapeType : int 

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

isDeleted/setDeleted : boolean 

boolean isDeleted() / setDeleted(value)
Indicates whether this data lables is deleted.

getTextHorizontalAlignment/setTextHorizontalAlignment : int 

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

getTextVerticalAlignment/setTextVerticalAlignment : int 

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

getRotationAngle/setRotationAngle : int 

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

255: Top to Bottom.

-90: Downward.

90: Upward.

getLinkedSource/setLinkedSource : String 

String getLinkedSource() / setLinkedSource(value)
Gets and sets a reference to the worksheet.

getTextDirection/setTextDirection : int 

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

isResizeShapeToFitText/setResizeShapeToFitText : boolean 

boolean isResizeShapeToFitText() / setResizeShapeToFitText(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 : boolean 

boolean isInnerMode() / setInnerMode(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 : Chart 

Chart getChart()

getTextFont : Font 

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 : boolean 

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

getBackground/setBackground : int 

int getBackground() / setBackground(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 : boolean 

boolean isAutomaticSize() / setAutomaticSize(value)
Indicates whether the chart frame is automatic sized.

getX/setX : int 

int getX() / setX(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 : int 

int getY() / setY(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 : int 

int getHeight() / setHeight(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 : int 

int getWidth() / setWidth(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 : boolean 

boolean getShadow() / setShadow(value)
True if the frame has a shadow.

getShapeProperties : ShapePropertyCollection 

ShapePropertyCollection getShapeProperties()
Gets the ShapeProperties object.

isDefaultPosBeSet : boolean 

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

getDefaultX : int 

int getDefaultX()
Represents x of default position

getDefaultY : int 

int getDefaultY()
Represents y of default position

getDefaultWidth : int 

int getDefaultWidth()
Represents width of default position

getDefaultHeight : int 

int getDefaultHeight()
Represents height of default position

Method Detail

characters

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

setPositionAuto

 setPositionAuto()
Set position of the frame to automatic

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