Excel.ChartTitle class

Represents a chart title object of a chart.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

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(option)

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

setFormula(formula)

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

[ API set: ExcelApi 1.7 ]

toJSON()

Property Details

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

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

load(option)

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

load(option?: string | string[]): Excel.ChartTitle;
Parameters
option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns
Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ChartTitle - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartTitle - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

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));
        }
    });
});

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

toJSON(): Excel.Interfaces.ChartTitleData;
Returns