Excel.ChartTitle class

Represents a chart title object of a chart.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

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. Read-only.

[ API set: ExcelApi 1.1 ]

height

Returns the height, in points, of the chart title. Null if chart title is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

horizontalAlignment

Represents the horizontal alignment for chart title.

[ API set: ExcelApi 1.7 ]

left

Represents the distance, in points, from the left edge of chart title to the left edge of chart area. Null if chart title is not visible.

[ API set: ExcelApi 1.7 ]

overlay

Boolean value representing if the chart title will overlay the chart or not.

[ API set: ExcelApi 1.1 ]

position

Represents the position of chart title. See Excel.ChartTitlePosition for details.

[ API set: ExcelApi 1.7 ]

showShadow

Represents a boolean value that determines if the chart title has a shadow.

[ API set: ExcelApi 1.7 ]

text

Represents the title text of a chart.

[ API set: ExcelApi 1.1 ]

textOrientation

Represents the text orientation of chart title. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.7 ]

top

Represents the distance, in points, from the top edge of chart title to the top of chart area. Null if chart title is not visible.

[ API set: ExcelApi 1.7 ]

verticalAlignment

Represents the vertical alignment of chart title. See Excel.ChartTextVerticalAlignment for details.

[ API set: ExcelApi 1.7 ]

visible

A boolean value the represents the visibility of a chart title object.

[ API set: ExcelApi 1.1 ]

width

Returns the width, in points, of the chart title. Null if chart title is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

Methods

getSubstring(start, length)

Get the substring of a chart title. Line break '\n' also counts one character.

[ API set: ExcelApi 1.7 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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.

setFormula(formula)

Sets a string value that represents the formula of chart title using A1-style notation.

[ API set: ExcelApi 1.7 ]

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.

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. Read-only.

[ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartTitleFormat;

Property Value

height

Returns the height, in points, of the chart title. Null if chart title is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

readonly height: number;

Property Value

number

horizontalAlignment

Represents the horizontal alignment for chart title.

[ API set: ExcelApi 1.7 ]

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

Property Value

Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"

left

Represents the distance, in points, from the left edge of chart title to the left edge of chart area. Null if chart title is not visible.

[ API set: ExcelApi 1.7 ]

left: number;

Property Value

number

overlay

Boolean value representing if the chart title will overlay the chart or not.

[ API set: ExcelApi 1.1 ]

overlay: boolean;

Property Value

boolean

position

Represents the position of chart title. See Excel.ChartTitlePosition for details.

[ API set: ExcelApi 1.7 ]

position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";

Property Value

Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"

showShadow

Represents a boolean value that determines if the chart title has a shadow.

[ API set: ExcelApi 1.7 ]

showShadow: boolean;

Property Value

boolean

text

Represents the title text of a chart.

[ API set: ExcelApi 1.1 ]

text: string;

Property Value

string

textOrientation

Represents the text orientation of chart title. The value should be an integer either from -90 to 90, or 180 for vertically-oriented text.

[ API set: ExcelApi 1.7 ]

textOrientation: number;

Property Value

number

Examples

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

Represents the distance, in points, from the top edge of chart title to the top of chart area. Null if chart title is not visible.

[ API set: ExcelApi 1.7 ]

top: number;

Property Value

number

verticalAlignment

Represents the vertical alignment of chart title. See Excel.ChartTextVerticalAlignment for details.

[ API set: ExcelApi 1.7 ]

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

Property Value

Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"

visible

A boolean value the represents the visibility of a chart title object.

[ API set: ExcelApi 1.1 ]

visible: boolean;

Property Value

boolean

width

Returns the width, in points, of the chart title. Null if chart title is not visible. Read-only.

[ API set: ExcelApi 1.7 ]

readonly width: number;

Property Value

number

Method Details

getSubstring(start, length)

Get the substring of a chart title. Line break '\n' also counts one character.

[ API set: ExcelApi 1.7 ]

getSubstring(start: number, length: number): Excel.ChartFormatString;

Parameters

start
number

Start position of substring to be retrieved. Position start with 0.

length
number

Length of substring to be retrieved.

Returns

Examples

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

options
Excel.Interfaces.ChartTitleLoadOptions

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

// Get the text of Chart Title from Chart1.
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    var title = chart.title;
    title.load('text');
    return ctx.sync().then(function() {
            console.log(title.text);
    }).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
    });
});
// Set the text of Chart Title to "My Chart" and Make it show on top of the chart without overlaying.
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    
    chart.title.text= "My Chart"; 
    chart.title.visible=true;
    chart.title.overlay=true;
    
    return ctx.sync().then(function() {
        console.log("Char Title Changed");
    }).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
    });
});

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

Remarks

This method has the following additional signature:

set(properties: Excel.ChartTitle): 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.

[ API set: ExcelApi 1.7 ]

setFormula(formula: string): void;

Parameters

formula
string

A string that represents the formula to set.

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.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