Excel.ChartDataLabel class
Represents the data label of a chart point.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.load("points");
await context.sync();
series.points.load("items");
await context.sync();
// Style a substring in the first data label.
let searchString = "sports";
let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
await context.sync();
let substringStart = dataLabel.text.indexOf(searchString);
let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.size = 13;
subLabel.font.bold = true;
// Style a substring in the second data label.
searchString = "'Titanic'";
dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
await context.sync();
substringStart = dataLabel.text.indexOf(searchString);
subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.name = "Calibri";
subLabel.font.size = 13;
subLabel.font.italic = true;
subLabel.font.color = "blue";
await context.sync();
});
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| 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. |
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
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
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
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's 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;