Excel.ChartLegendFormat class

Encapsulates the format properties of a chart legend.

[ API set: ExcelApi 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

fill

Represents the fill format of an object, which includes background formating information. Read-only.

[ API set: ExcelApi 1.1 ]

font

Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.

[ API set: ExcelApi 1.1 ]

Methods

load(option)

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

toJSON()

Property Details

fill

Represents the fill format of an object, which includes background formating information. Read-only.

[ API set: ExcelApi 1.1 ]

readonly fill: Excel.ChartFill;
Property Value

font

Represents the font attributes such as font name, font size, color, etc. of a chart legend. Read-only.

[ API set: ExcelApi 1.1 ]

readonly font: Excel.ChartFont;
Property Value

Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    let chart = sheet.charts.getItemAt(0);
    chart.legend.visible = true;

    // Format the legend font.
    let font = chart.legend.format.font;
    font.bold = true;
    font.color = "red";
    font.italic = true;
    font.size = 15;
    font.name = "Calibri";
    font.underline = "Single";

    await context.sync();
});

Method Details

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

toJSON()

toJSON(): Excel.Interfaces.ChartLegendFormatData;
Returns