aspose.cells

Classes

Constants

Class DataLabels

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

Example:

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

Method Summary
`function`	`characters(startIndex, length)`
`function`	Returns a Characters object that represents a range of characters within the text.
`function`	`setPositionAuto()`
`function`	Set position of the frame to automatic

- Property Getters/Setters Detail
  - getBorder : Line
```
function getBorder()
```
    Gets the Line.
  - getArea : Area
```
function getArea()
```
    Gets the Area.
  - isAutoText/setAutoText : boolean
```
function isAutoText() / function setAutoText(value)
```
    Indicates the text is auto generated.
  - getDirectionType/setDirectionType : Number
```
function getDirectionType() / function setDirectionType(value)
```
    Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
  - getText/setText : String
```
function getText() / function setText(value)
```
    Gets or sets the text of data label.
  - isTextWrapped/setTextWrapped : boolean
```
function isTextWrapped() / function setTextWrapped(value)
```
    Gets or sets a value indicating whether the text is wrapped.
  - getBackgroundMode/setBackgroundMode : Number
```
function getBackgroundMode() / function setBackgroundMode(value)
```
    Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
  - getShowValue/setShowValue : boolean
```
function getShowValue() / function setShowValue(value)
```
    Represents a specified chart's data label values display behavior. True displays the values. False to hide.
  - getShowCellRange/setShowCellRange : boolean
```
function getShowCellRange() / function setShowCellRange(value)
```
    Indicates whether showing cell range as the data labels.
  - getShowPercentage/setShowPercentage : boolean
```
function getShowPercentage() / function setShowPercentage(value)
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - getShowBubbleSize/setShowBubbleSize : boolean
```
function getShowBubbleSize() / function setShowBubbleSize(value)
```
    Represents a specified chart's data label percentage value display behavior. True displays the percentage value. False to hide.
  - getShowCategoryName/setShowCategoryName : boolean
```
function getShowCategoryName() / function 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
```
function getShowSeriesName() / function 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
```
function getShowLegendKey() / function 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
```
function getNumberFormat() / function setNumberFormat(value)
```
    Represents the format string for the DataLabels object.
  - getNumber/setNumber : Number
```
function getNumber() / function setNumber(value)
```
    Gets and sets the built-in number format.
  - getNumberFormatLinked/setNumberFormatLinked : boolean
```
function getNumberFormatLinked() / function 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
```
function getFont()
```
    Gets the font of the DataLabels;
  - getSeparator/setSeparator : Number
```
function getSeparator() / function 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 : Number
```
function getSeparatorType() / function 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
```
function getSeparatorValue() / function setSeparatorValue(value)
```
    Gets or sets the separator value used for the data labels on a chart.
  - getPosition/setPosition : Number
```
function getPosition() / function setPosition(value)
```
    Represents the position of the data label. The value of the property is LabelPositionType integer constant.
  - isNeverOverlap/setNeverOverlap : boolean
```
function isNeverOverlap() / function setNeverOverlap(value)
```
    Indicates whether the datalabels display never overlap. (For Pie chart)
  - getShapeType/setShapeType : Number
```
function getShapeType() / function setShapeType(value)
```
    Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
  - isDeleted/setDeleted : boolean
```
function isDeleted() / function setDeleted(value)
```
    Indicates whether this data labels is deleted.
  - getTextHorizontalAlignment/setTextHorizontalAlignment : Number
```
function getTextHorizontalAlignment() / function setTextHorizontalAlignment(value)
```
    Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
  - getTextVerticalAlignment/setTextVerticalAlignment : Number
```
function getTextVerticalAlignment() / function setTextVerticalAlignment(value)
```
    Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
  - getRotationAngle/setRotationAngle : Number
```
function getRotationAngle() / function setRotationAngle(value)
```
    Represents text rotation angle.
    
    0: Not rotated.
    
    255: Top to Bottom.
    
    -90: Downward.
    
    90: Upward.
  - getLinkedSource/setLinkedSource : String
```
function getLinkedSource() / function setLinkedSource(value)
```
    Gets and sets a reference to the worksheet.
  - getTextDirection/setTextDirection : Number
```
function getTextDirection() / function 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 : Number
```
function getReadingOrder() / function setReadingOrder(value)
```
    Represents text reading order. The value of the property is TextDirectionType integer constant.
  - isResizeShapeToFitText/setResizeShapeToFitText : boolean
```
function isResizeShapeToFitText() / function 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
```
function isInnerMode() / function 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
```
function getChart()
```
    Gets the chart to which this object belongs.
  - getTextFont : Font
```
function 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
```
function getAutoScaleFont() / function setAutoScaleFont(value)
```
    True if the text in the object changes font size when the object size changes. The default value is True.
  - getBackground/setBackground : Number
```
function getBackground() / function 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
```
function isAutomaticSize() / function setAutomaticSize(value)
```
    Indicates whether the chart frame is automatic sized.
  - getX/setX : Number
```
function getX() / function 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 : Number
```
function getY() / function 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 : Number
```
function getHeight() / function 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 : Number
```
function getWidth() / function 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
```
function getShadow() / function setShadow(value)
```
    True if the frame has a shadow.
  - getShapeProperties : ShapePropertyCollection
```
function getShapeProperties()
```
    Gets the ShapeProperties object.
  - isDefaultPosBeSet : boolean
```
function isDefaultPosBeSet()
```
    Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
  - getDefaultX : Number
```
function getDefaultX()
```
    Represents x of default position
  - getDefaultY : Number
```
function getDefaultY()
```
    Represents y of default position
  - getDefaultWidth : Number
```
function getDefaultWidth()
```
    Represents width of default position
  - getDefaultHeight : Number
```
function getDefaultHeight()
```
    Represents height of default position
- Method Detail
  - characters
```
function characters(startIndex, length)
```
    Returns a Characters object that represents a range of characters within the text.
    Parameters:
    startIndex: Number - The index of the start of the character.
    length: Number - The number of characters.
    Returns:
    Characters object.
  - setPositionAuto
```
function setPositionAuto()
```
    Set position of the frame to automatic

aspose.cells

Classes

Constants

Class DataLabels

Property Getters/Setters Detail

getBorder : Line

getArea : Area

isAutoText/setAutoText : boolean

getDirectionType/setDirectionType : Number

getText/setText : String

isTextWrapped/setTextWrapped : boolean

getBackgroundMode/setBackgroundMode : Number

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

getNumberFormatLinked/setNumberFormatLinked : boolean

getFont : Font

getSeparator/setSeparator : Number

getSeparatorType/setSeparatorType : Number

getSeparatorValue/setSeparatorValue : String

getPosition/setPosition : Number

isNeverOverlap/setNeverOverlap : boolean

getShapeType/setShapeType : Number

isDeleted/setDeleted : boolean

getTextHorizontalAlignment/setTextHorizontalAlignment : Number

getTextVerticalAlignment/setTextVerticalAlignment : Number

getRotationAngle/setRotationAngle : Number

getLinkedSource/setLinkedSource : String

getTextDirection/setTextDirection : Number

getReadingOrder/setReadingOrder : Number

isResizeShapeToFitText/setResizeShapeToFitText : boolean

isInnerMode/setInnerMode : boolean

getChart : Chart

getTextFont : Font

getAutoScaleFont/setAutoScaleFont : boolean

getBackground/setBackground : Number

isAutomaticSize/setAutomaticSize : boolean

getX/setX : Number

getY/setY : Number

getHeight/setHeight : Number

getWidth/setWidth : Number

getShadow/setShadow : boolean

getShapeProperties : ShapePropertyCollection

isDefaultPosBeSet : boolean

getDefaultX : Number

getDefaultY : Number

getDefaultWidth : Number

getDefaultHeight : Number

Method Detail

characters

setPositionAuto