Excel.ChartDataLabel class
Represents the data label of a chart point.
- Extends
Remarks
Properties
auto |
Specifies if the data label automatically generates appropriate text based on context. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
format | Represents the format of chart data label. |
formula | String value that represents the formula of chart data label using A1-style notation. |
height | Returns the height, in points, of the chart data label. Value is |
horizontal |
Represents the horizontal alignment for chart data label. See |
left | Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is |
link |
Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). |
number |
String value that represents the format code for data label. |
position | Value that represents the position of the data label. See |
separator | String representing the separator used for the data label on a chart. |
show |
Specifies if the data label bubble size is visible. |
show |
Specifies if the data label category name is visible. |
show |
Specifies if the data label legend key is visible. |
show |
Specifies if the data label percentage is visible. |
show |
Specifies if the data label series name is visible. |
show |
Specifies if the data label value is visible. |
text | String representing the text of the data label on a chart. |
text |
Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. |
top | Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is |
vertical |
Represents the vertical alignment of chart data label. See |
width | Returns the width, in points, of the chart data label. Value is |
Methods
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
toJSON() | Overrides the JavaScript |
Property Details
autoText
Specifies if the data label automatically generates appropriate text based on context.
autoText: boolean;
Property Value
boolean
Remarks
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
format
Represents the format of chart data label.
readonly format: Excel.ChartDataLabelFormat;
Property Value
Remarks
formula
String value that represents the formula of chart data label using A1-style notation.
formula: string;
Property Value
string
Remarks
height
Returns the height, in points, of the chart data label. Value is null
if the chart data label is not visible.
readonly height: number;
Property Value
number
Remarks
horizontalAlignment
Represents the horizontal alignment for chart data label. See Excel.ChartTextHorizontalAlignment
for details. This property is valid only when TextOrientation
of data label is -90, 90, or 180.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";
Property Value
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Remarks
left
Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value is null
if the chart data label is not visible.
left: number;
Property Value
number
Remarks
linkNumberFormat
Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).
linkNumberFormat: boolean;
Property Value
boolean
Remarks
numberFormat
String value that represents the format code for data label.
numberFormat: string;
Property Value
string
Remarks
position
Value that represents the position of the data label. See Excel.ChartDataLabelPosition
for details.
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";
Property Value
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
Remarks
separator
String representing the separator used for the data label on a chart.
separator: string;
Property Value
string
Remarks
showBubbleSize
Specifies if the data label bubble size is visible.
showBubbleSize: boolean;
Property Value
boolean
Remarks
showCategoryName
Specifies if the data label category name is visible.
showCategoryName: boolean;
Property Value
boolean
Remarks
showLegendKey
Specifies if the data label legend key is visible.
showLegendKey: boolean;
Property Value
boolean
Remarks
showPercentage
Specifies if the data label percentage is visible.
showPercentage: boolean;
Property Value
boolean
Remarks
showSeriesName
Specifies if the data label series name is visible.
showSeriesName: boolean;
Property Value
boolean
Remarks
showValue
Specifies if the data label value is visible.
showValue: boolean;
Property Value
boolean
Remarks
text
String representing the text of the data label on a chart.
text: string;
Property Value
string
Remarks
textOrientation
Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
textOrientation: number;
Property Value
number
Remarks
top
Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is null
if the chart data label is not visible.
top: number;
Property Value
number
Remarks
verticalAlignment
Represents the vertical alignment of chart data label. See Excel.ChartTextVerticalAlignment
for details. This property is valid only when TextOrientation
of data label is 0.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
Property Value
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Remarks
width
Returns the width, in points, of the chart data label. Value is null
if the chart data label is not visible.
readonly width: number;
Property Value
number
Remarks
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;
Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Excel.ChartDataLabel;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartDataLabel;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameters
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Excel.ChartDataLabel): void;
Parameters
- properties
- Excel.ChartDataLabel
Returns
void
toJSON()
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Excel.ChartDataLabel
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.ChartDataLabelData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ChartDataLabelData;
Returns
Office Add-ins