asposecells.api

Classes

Constants

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.setShowValue(True)
    # Not show the percentage in the DataLabels
    datalabels.setPercentageShown(False)
    # Not show the legend key.
    datalabels.setLegendKeyShown(False)

Property Getters/Setters Summary
`method`	`getArea()`
	Gets the Area.
`method`	`getAutoScaleFont()`
`method`	`setAutoScaleFont(value)`
	True if the text in the object changes font size when the object size changes. The default value is True.
`method`	`getBackground()`
`method`	`setBackground(value)`
	Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
`method`	`getBackgroundMode()`
`method`	`setBackgroundMode(value)`
	Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
`method`	`getBorder()`
	Gets the Line.
`method`	`getChart()`
	Gets the chart to which this object belongs.
`method`	`getDefaultHeight()`
	Represents height of default position
`method`	`getDefaultWidth()`
	Represents width of default position
`method`	`getDefaultX()`
	Represents x of default position
`method`	`getDefaultY()`
	Represents y of default position
`method`	`getDirectionType()`
`method`	`setDirectionType(value)`
	Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
`method`	`getFont()`
	Gets the font of the DataLabels;
`method`	`getHeight()`
`method`	`setHeight(value)`
	Gets or sets the height of frame in units of 1/4000 of the chart area.
`method`	`isAutomaticSize()`
`method`	`setAutomaticSize(value)`
	Indicates whether the chart frame is automatic sized.
`method`	`isAutoText()`
`method`	`setAutoText(value)`
	Indicates the text is auto generated.
`method`	`isDefaultPosBeSet()`
	Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
`method`	`isDeleted()`
`method`	`setDeleted(value)`
	Indicates whether this data labels is deleted.
`method`	`isInnerMode()`
`method`	`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.
`method`	`isNeverOverlap()`
`method`	`setNeverOverlap(value)`
	Indicates whether the datalabels display never overlap. (For Pie chart)
`method`	`isResizeShapeToFitText()`
`method`	`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.
`method`	`isTextWrapped()`
`method`	`setTextWrapped(value)`
	Gets or sets a value indicating whether the text is wrapped.
`method`	`getLinkedSource()`
`method`	`setLinkedSource(value)`
	Gets and sets a reference to the worksheet.
`method`	`getNumber()`
`method`	`setNumber(value)`
	Gets and sets the built-in number format.
`method`	`getNumberFormat()`
`method`	`setNumberFormat(value)`
	Represents the format string for the DataLabels object.
`method`	`getNumberFormatLinked()`
`method`	`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).
`method`	`getPosition()`
`method`	`setPosition(value)`
	Represents the position of the data label. The value of the property is LabelPositionType integer constant.
`method`	`getReadingOrder()`
`method`	`setReadingOrder(value)`
	Represents text reading order. The value of the property is TextDirectionType integer constant.
`method`	`getRotationAngle()`
`method`	`setRotationAngle(value)`
	Represents text rotation angle.
`method`	`getSeparator()`
`method`	`setSeparator(value)`
	Gets or sets the separator type used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.
`method`	`getSeparatorType()`
`method`	`setSeparatorType(value)`
	Gets or sets the separator type used for the data labels on a chart. The value of the property is DataLabelsSeparatorType integer constant.
`method`	`getSeparatorValue()`
`method`	`setSeparatorValue(value)`
	Gets or sets the separator value used for the data labels on a chart.
`method`	`getShadow()`
`method`	`setShadow(value)`
	True if the frame has a shadow.
`method`	`getShapeProperties()`
	Gets the ShapeProperties object.
`method`	`getShapeType()`
`method`	`setShapeType(value)`
	Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
`method`	`getShowBubbleSize()`
`method`	`setShowBubbleSize(value)`
	Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
`method`	`getShowCategoryName()`
`method`	`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.
`method`	`getShowCellRange()`
`method`	`setShowCellRange(value)`
	Indicates whether showing cell range as the data labels.
`method`	`getShowLegendKey()`
`method`	`setShowLegendKey(value)`
	Represents a specified chart's data label legend key display behavior. True if the data label legend key is visible.
`method`	`getShowPercentage()`
`method`	`setShowPercentage(value)`
	Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
`method`	`getShowSeriesName()`
`method`	`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.
`method`	`getShowValue()`
`method`	`setShowValue(value)`
	Represents a specified chart's data label values display behavior. True displays the values. False to hide.
`method`	`getText()`
`method`	`setText(value)`
	Gets or sets the text of data label.
`method`	`getTextDirection()`
`method`	`setTextDirection(value)`
	Represents text reading order. The value of the property is TextDirectionType integer constant.
`method`	`getTextFont()`
	Gets a Font object of the specified ChartFrame object.
`method`	`getTextHorizontalAlignment()`
`method`	`setTextHorizontalAlignment(value)`
	Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
`method`	`getTextVerticalAlignment()`
`method`	`setTextVerticalAlignment(value)`
	Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
`method`	`getWidth()`
`method`	`setWidth(value)`
	Gets or sets the width of frame in units of 1/4000 of the chart area.
`method`	`getX()`
`method`	`setX(value)`
	Gets or sets the x coordinate of the upper left corner in units of 1/4000 of the chart area.
`method`	`getY()`
`method`	`setY(value)`
	Gets or sets the y coordinate of the upper left corner in units of 1/4000 of the chart area.

Method Summary
`method`	`characters(startIndex, length)`
`method`	Returns a Characters object that represents a range of characters within the text.
`method`	`setPositionAuto()`
`method`	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.
  - getDirectionType/setDirectionType : int
```
int getDirectionType() / setDirectionType(value)
```
    Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
  - getText/setText : String
```
String getText() / setText(value)
```
    Gets or sets the text of data label.
  - 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 and 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)
```
    Gets or sets the separator type used for the data labels on a chart. The value of the property is DataLablesSeparatorType integer constant.
    NOTE: This member is now obsolete. Instead, please use DataLabels.SeparatorType property. This property will be removed 12 months later since September 2020. Aspose apologizes for any inconvenience you may have experienced.
  - getSeparatorType/setSeparatorType : int
```
int getSeparatorType() / setSeparatorType(value)
```
    Gets or sets the separator type used for the data labels on a chart. The value of the property is DataLabelsSeparatorType integer constant.
    To set custom separator, please set the property SeparatorType as DataLabelsSeparatorType.CUSTOM and then specify the expected value for SeparatorValue.
  - getSeparatorValue/setSeparatorValue : String
```
String getSeparatorValue() / setSeparatorValue(value)
```
    Gets or sets the separator value used for the data labels on a chart.
  - getPosition/setPosition : int
```
int getPosition() / setPosition(value)
```
    Represents the position of the data label. The value of the property is LabelPositionType integer constant.
  - isNeverOverlap/setNeverOverlap : boolean
```
boolean isNeverOverlap() / setNeverOverlap(value)
```
    Indicates whether the datalabels display never overlap. (For Pie chart)
  - 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 labels is deleted.
  - getTextHorizontalAlignment/setTextHorizontalAlignment : int
```
int getTextHorizontalAlignment() / setTextHorizontalAlignment(value)
```
    Gets and 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.
    NOTE: This member is now obsolete. Instead, please use ChartTextFrame.ReadingOrder property. This property will be removed 12 months later since March 2020. Aspose apologizes for any inconvenience you may have experienced.
  - getReadingOrder/setReadingOrder : int
```
int getReadingOrder() / setReadingOrder(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()
```
    Gets the chart to which this object belongs.
  - 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

asposecells.api

Classes

Constants

Class DataLabels

Property Getters/Setters Detail

getBorder : Line

getArea : Area

isAutoText/setAutoText : boolean

getDirectionType/setDirectionType : int

getText/setText : String

isTextWrapped/setTextWrapped : boolean

getBackgroundMode/setBackgroundMode : int

getShowValue/setShowValue : boolean

getShowCellRange/setShowCellRange : boolean

getShowPercentage/setShowPercentage : boolean

getShowBubbleSize/setShowBubbleSize : boolean

getShowCategoryName/setShowCategoryName : boolean

getShowSeriesName/setShowSeriesName : boolean

getShowLegendKey/setShowLegendKey : boolean

getNumberFormat/setNumberFormat : String

getNumber/setNumber : int

getNumberFormatLinked/setNumberFormatLinked : boolean

getFont : Font

getSeparator/setSeparator : int

getSeparatorType/setSeparatorType : int

getSeparatorValue/setSeparatorValue : String

getPosition/setPosition : int

isNeverOverlap/setNeverOverlap : boolean

getShapeType/setShapeType : int

isDeleted/setDeleted : boolean

getTextHorizontalAlignment/setTextHorizontalAlignment : int

getTextVerticalAlignment/setTextVerticalAlignment : int

getRotationAngle/setRotationAngle : int

getLinkedSource/setLinkedSource : String

getTextDirection/setTextDirection : int

getReadingOrder/setReadingOrder : int

isResizeShapeToFitText/setResizeShapeToFitText : boolean

isInnerMode/setInnerMode : boolean

getChart : Chart

getTextFont : Font

getAutoScaleFont/setAutoScaleFont : boolean

getBackground/setBackground : int

isAutomaticSize/setAutomaticSize : boolean

getX/setX : int

getY/setY : int

getHeight/setHeight : int

getWidth/setWidth : int

getShadow/setShadow : boolean

getShapeProperties : ShapePropertyCollection

isDefaultPosBeSet : boolean

getDefaultX : int

getDefaultY : int

getDefaultWidth : int

getDefaultHeight : int

Method Detail

characters

setPositionAuto