DataLabels
DataLabels class
Encapsulates a collection of all the DataLabel objects for the specified Series.
Properties
| Name | Type | Description |
|---|---|---|
| Border | Line | Gets the Line . |
| Area | Area | Gets the Area . |
| IsAutoText | boolean | Indicates the text is auto generated. |
| DirectionType | int | Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant. |
| Text | String | Gets or sets the text of data label. |
| IsTextWrapped | boolean | Gets or sets a value indicating whether the text is wrapped. |
| BackgroundMode | int | Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. |
| ShowValue | boolean | Represents a specified chart’s data label values display behavior. True displays the values. False to hide. |
| ShowCellRange | boolean | Indicates whether showing cell range as the data labels. |
| ShowPercentage | boolean | Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False t |
| ShowBubbleSize | boolean | Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False t |
| ShowCategoryName | boolean | Represents a specified chart’s data label category name display behavior.True to display the category name for the data |
| ShowSeriesName | boolean | Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide. |
| ShowLegendKey | boolean | Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible. |
| NumberFormat | String | Represents the format string for the DataLabels object. |
| Number | int | Gets and sets the built-in number format. |
| NumberFormatLinked | boolean | True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the |
| Font | Font | Gets the font of the DataLabels; |
| SeparatorType | int | Gets or sets the separator type used for the data labels on a chart. The value of the property is DataLabelsSeparatorTyp |
| SeparatorValue | String | Gets or sets the separator value used for the data labels on a chart. |
| Position | int | Represents the position of the data label. The value of the property is LabelPositionType integer constant. |
| IsNeverOverlap | boolean | Indicates whether the datalabels display never overlap. (For Pie chart) |
| ShapeType | int | Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant. |
| IsDeleted | boolean | Indicates whether this data labels is deleted. |
| TextHorizontalAlignment | int | Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant. |
| TextVerticalAlignment | int | Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant. |
| RotationAngle | int | Represents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward. |
| IsAutomaticRotation | boolean | Indicates whether the text of the chart is automatically rotated. |
| LinkedSource | String | Gets and sets a reference to the worksheet. |
| TextDirection | int | Represents text reading order. The value of the property is TextDirectionType integer constant. NOTE: This member is now |
| ReadingOrder | int | Represents text reading order. The value of the property is TextDirectionType integer constant. |
| IsResizeShapeToFitText | boolean | Gets or sets whether a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text |
| IsInnerMode | boolean | Indicates whether the size of the plot area size includes the tick marks, and the axis labels. False specifies that the |
| Chart | Chart | Gets the chart to which this object belongs. |
| TextFont | Font | Gets a Font object of the specified ChartFrame object. NOTE: This member is now obsolete. Instead, please use ChartFrame |
| TextOptions | TextOptions | Gets and sets the options of the text. |
| AutoScaleFont | boolean | True if the text in the object changes font size when the object size changes. The default value is True. |
| Background | int | Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant. NOTE: Thi |
| IsAutomaticSize | boolean | Indicates whether the chart frame is automatic sized. |
| X | int | 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/4 |
| Y | int | 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/4 |
| Height | int | 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 |
| Width | int | 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 |
| Shadow | boolean | True if the frame has a shadow. |
| ShapeProperties | ShapePropertyCollection | Gets the ShapeProperties object. |
| IsDefaultPosBeSet | boolean | Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set. |
| DefaultX | int | Represents x of default position |
| DefaultY | int | Represents y of default position |
| DefaultWidth | int | Represents width of default position |
| DefaultHeight | int | Represents height of default position |
| DefaultXRatioToChart | float | |
| DefaultYRatioToChart | float | |
| DefaultWidthRatioToChart | float | |
| DefaultHeightRatioToChart | float | |
| XRatioToChart | float | |
| YRatioToChart | float | |
| WidthRatioToChart | float | |
| HeightRatioToChart | float | |
| XPixel | int | |
| YPixel | int | |
| WidthPixel | int | Represents width |
| HeightPixel | int | Represents height |
Methods
| Name | Description |
|---|---|
| applyFont | Apply the font of the datalabels to all child nodes. |
| characters | Returns a Characters object that represents a range of characters within the text. |
| setPositionAuto | Set position of the frame to automatic |
DataLabels.Border property
Gets the Line .
Type: Line
DataLabels.Area property
Gets the Area .
Type: Area
DataLabels.IsAutoText property
Indicates the text is auto generated.
Type: boolean
DataLabels.DirectionType property
Gets and sets the direction of text. The value of the property is ChartTextDirectionType integer constant.
Type: int
DataLabels.Text property
Gets or sets the text of data label.
Type: String
DataLabels.IsTextWrapped property
Gets or sets a value indicating whether the text is wrapped.
Type: boolean
DataLabels.BackgroundMode property
Gets and sets the display mode of the background The value of the property is BackgroundMode integer constant.
Type: int
DataLabels.ShowValue property
Represents a specified chart’s data label values display behavior. True displays the values. False to hide.
Type: boolean
DataLabels.ShowCellRange property
Indicates whether showing cell range as the data labels.
Type: boolean
DataLabels.ShowPercentage property
Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
Type: boolean
DataLabels.ShowBubbleSize property
Represents a specified chart’s data label percentage value display behavior. True displays the percentage value. False to hide.
Type: boolean
DataLabels.ShowCategoryName property
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.
Type: boolean
DataLabels.ShowSeriesName property
Indicates whether the series name displays for the data labels on a chart. True to show the series name. False to hide.
Type: boolean
DataLabels.ShowLegendKey property
Represents a specified chart’s data label legend key display behavior. True if the data label legend key is visible.
Type: boolean
DataLabels.NumberFormat property
Represents the format string for the DataLabels object.
Type: String
DataLabels.Number property
Gets and sets the built-in number format.
Type: int
DataLabels.NumberFormatLinked property
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).
Type: boolean
DataLabels.Font property
Gets the font of the DataLabels;
Type: Font
DataLabels.SeparatorType property
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 .
Type: int
DataLabels.SeparatorValue property
Gets or sets the separator value used for the data labels on a chart.
Type: String
DataLabels.Position property
Represents the position of the data label. The value of the property is LabelPositionType integer constant.
Type: int
DataLabels.IsNeverOverlap property
Indicates whether the datalabels display never overlap. (For Pie chart)
Type: boolean
DataLabels.ShapeType property
Gets or sets shape type of data label. The value of the property is DataLabelShapeType integer constant.
Type: int
DataLabels.IsDeleted property
Indicates whether this data labels is deleted.
Type: boolean
DataLabels.TextHorizontalAlignment property
Gets and sets the text horizontal alignment. The value of the property is TextAlignmentType integer constant.
Type: int
DataLabels.TextVerticalAlignment property
Gets or sets the text vertical alignment of text. The value of the property is TextAlignmentType integer constant.
Type: int
DataLabels.RotationAngle property
Represents text rotation angle. 0: Not rotated. 255: Top to Bottom. -90: Downward. 90: Upward.
Type: int
DataLabels.IsAutomaticRotation property
Indicates whether the text of the chart is automatically rotated.
Type: boolean
DataLabels.LinkedSource property
Gets and sets a reference to the worksheet.
Type: String
DataLabels.TextDirection property
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.
Type: int
DataLabels.ReadingOrder property
Represents text reading order. The value of the property is TextDirectionType integer constant.
Type: int
DataLabels.IsResizeShapeToFitText property
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.
Type: boolean
DataLabels.IsInnerMode property
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.
Type: boolean
DataLabels.Chart property
Gets the chart to which this object belongs.
Type: Chart
DataLabels.TextFont property
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.
Type: Font
DataLabels.TextOptions property
Gets and sets the options of the text.
Type: TextOptions
DataLabels.AutoScaleFont property
True if the text in the object changes font size when the object size changes. The default value is True.
Type: boolean
DataLabels.Background property
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.
Type: int
DataLabels.IsAutomaticSize property
Indicates whether the chart frame is automatic sized.
Type: boolean
DataLabels.X property
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;
Type: int
DataLabels.Y property
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;
Type: int
DataLabels.Height property
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;
Type: int
DataLabels.Width property
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;
Type: int
DataLabels.Shadow property
True if the frame has a shadow.
Type: boolean
DataLabels.ShapeProperties property
Gets the ShapeProperties object.
Type: ShapePropertyCollection
DataLabels.IsDefaultPosBeSet property
Indicates whether default position(DefaultX, DefaultY, DefaultWidth and DefaultHeight) are set.
Type: boolean
DataLabels.DefaultX property
Represents x of default position
Type: int
DataLabels.DefaultY property
Represents y of default position
Type: int
DataLabels.DefaultWidth property
Represents width of default position
Type: int
DataLabels.DefaultHeight property
Represents height of default position
Type: int
DataLabels.DefaultXRatioToChart property
Type: float
DataLabels.DefaultYRatioToChart property
Type: float
DataLabels.DefaultWidthRatioToChart property
Type: float
DataLabels.DefaultHeightRatioToChart property
Type: float
DataLabels.XRatioToChart property
Type: float
DataLabels.YRatioToChart property
Type: float
DataLabels.WidthRatioToChart property
Type: float
DataLabels.HeightRatioToChart property
Type: float
DataLabels.XPixel property
Type: int
DataLabels.YPixel property
Type: int
DataLabels.WidthPixel property
Represents width
Type: int
DataLabels.HeightPixel property
Represents height
Type: int
applyFont()
Apply the font of the datalabels to all child nodes.
characters(startIndex, length)
Returns a Characters object that represents a range of characters within the text.
| Parameter | Type | Description |
|---|---|---|
| startIndex | int | The index of the start of the character. |
| length | int | The number of characters. |
Returns: Characters object.
setPositionAuto()
Set position of the frame to automatic