Excel.ChartTitle class
Represents a chart title object of a chart.
- Extends
Remarks
Properties
| 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 formatting of a chart title, which includes fill and font formatting. |
| height | Returns the height, in points, of the chart title. Value is |
| horizontal |
Specifies the horizontal alignment for chart title. |
| left | Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is |
| overlay | Specifies if the chart title will overlay the chart. |
| position | Represents the position of chart title. See |
| show |
Represents a boolean value that determines if the chart title has a shadow. |
| text | Specifies the chart's title text. |
| text |
Specifies the angle to which the text is oriented for the chart title. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text. |
| top | Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is |
| vertical |
Specifies the vertical alignment of chart title. See |
| visible | Specifies if the chart title is visible. |
| width | Specifies the width, in points, of the chart title. Value is |
Methods
| get |
Get the substring of a chart title. Line break '\n' counts one character. |
| 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. |
| set |
Sets a string value that represents the formula of chart title using A1-style notation. |
| 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
format
Represents the formatting of a chart title, which includes fill and font formatting.
readonly format: Excel.ChartTitleFormat;Property Value
Remarks
height
Returns the height, in points, of the chart title. Value is null if the chart title is not visible.
readonly height: number;Property Value
number
Remarks
horizontalAlignment
Specifies the horizontal alignment for chart title.
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";Property Value
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
Remarks
left
Specifies the distance, in points, from the left edge of chart title to the left edge of chart area. Value is null if the chart title is not visible.
left: number;Property Value
number
Remarks
overlay
Specifies if the chart title will overlay the chart.
overlay: boolean;Property Value
boolean
Remarks
position
Represents the position of chart title. See Excel.ChartTitlePosition for details.
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";Property Value
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
Remarks
showShadow
Represents a boolean value that determines if the chart title has a shadow.
showShadow: boolean;Property Value
boolean
Remarks
text
Specifies the chart's title text.
text: string;Property Value
string
Remarks
textOrientation
Specifies the angle to which the text is oriented for the chart title. 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
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const title = sheet.charts.getItemAt(0).title;
title.textOrientation = -45;
await context.sync();
});
top
Specifies the distance, in points, from the top edge of chart title to the top of chart area. Value is null if the chart title is not visible.
top: number;Property Value
number
Remarks
verticalAlignment
Specifies the vertical alignment of chart title. See Excel.ChartTextVerticalAlignment for details.
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";Property Value
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
Remarks
visible
Specifies if the chart title is visible.
visible: boolean;Property Value
boolean
Remarks
width
Specifies the width, in points, of the chart title. Value is null if the chart title is not visible.
readonly width: number;Property Value
number
Remarks
Method Details
getSubstring(start, length)
Get the substring of a chart title. Line break '\n' counts one character.
getSubstring(start: number, length: number): Excel.ChartFormatString;Parameters
- start
-
number
Start position of substring to be retrieved. Zero-indexed.
- length
-
number
Length of the substring to be retrieved.
Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItemAt(0);
// Get first seven characters of the title and color them green.
chart.title.getSubstring(0, 7).font.color = "Yellow";
await context.sync();
});
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.ChartTitleLoadOptions): Excel.ChartTitle;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.ChartTitle;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.title.text= "My Chart";
chart.title.visible=true;
chart.title.overlay=true;
await context.sync();
console.log("Char Title Changed");
});
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.ChartTitle;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.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Excel.Interfaces.ChartTitleUpdateData
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.ChartTitle): void;Parameters
- properties
- Excel.ChartTitle
Returns
void
setFormula(formula)
Sets a string value that represents the formula of chart title using A1-style notation.
setFormula(formula: string): void;Parameters
- formula
-
string
A string that represents the formula to set.
Returns
void
Remarks
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.ChartTitle object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartTitleData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.ChartTitleData;Returns
Office Add-ins