Excel.ChartLegendFormat class

Package:

excel

Encapsulates the format properties of a chart legend.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.1 ]

Properties

border	Represents the border format, which includes color, linestyle, and weight.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
fill	Represents the fill format of an object, which includes background formatting information.
font	Represents the font attributes such as font name, font size, and color of a chart legend.

Methods

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.
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.ChartLegendFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLegendFormatData) that contains shallow copies of any loaded child properties from the original object.

Property Details

border

Represents the border format, which includes color, linestyle, and weight.

readonly border: Excel.ChartBorder;

Property Value

Excel.ChartBorder

Remarks

[ API set: ExcelApi 1.8 ]

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

Excel.RequestContext

fill

Represents the fill format of an object, which includes background formatting information.

readonly fill: Excel.ChartFill;

Property Value

Excel.ChartFill

Remarks

[ API set: ExcelApi 1.1 ]

font

Represents the font attributes such as font name, font size, and color of a chart legend.

readonly font: Excel.ChartFont;

Property Value

Excel.ChartFont

Remarks

[ API set: ExcelApi 1.1 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-legend.yaml

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(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.ChartLegendFormatLoadOptions): Excel.ChartLegendFormat;

Parameters

options

Excel.Interfaces.ChartLegendFormatLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartLegendFormat

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

Parameters

propertyNames

string | string[]

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

Returns

Excel.ChartLegendFormat

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

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

Excel.ChartLegendFormat

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.ChartLegendFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Excel.Interfaces.ChartLegendFormatUpdateData

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.ChartLegendFormat): void;

Parameters

properties

Excel.ChartLegendFormat

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.ChartLegendFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLegendFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartLegendFormatData;

Returns

Excel.Interfaces.ChartLegendFormatData