Excel.ChartLegend class

Represents the legend in 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 legend, which includes fill and font formatting. Read-only.

[ API set: ExcelApi 1.1 ]

height

Represents the height, in points, of the legend on the chart. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

left

Represents the left, in points, of a chart legend. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

legendEntries

Represents a collection of legendEntries in the legend. Read-only.

[ API set: ExcelApi 1.7 ]

overlay

Boolean value for whether the chart legend should overlap with the main body of the chart.

[ API set: ExcelApi 1.1 ]

position

Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details.

[ API set: ExcelApi 1.1 ]

showShadow

Represents if the legend has a shadow on the chart.

[ API set: ExcelApi 1.7 ]

top

Represents the top of a chart legend.

[ API set: ExcelApi 1.7 ]

visible

A boolean value the represents the visibility of a ChartLegend object.

[ API set: ExcelApi 1.1 ]

width

Represents the width, in points, of the legend on the chart. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

Methods

load(option)

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.ChartLegend object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartLegendData) 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 legend, which includes fill and font formatting. Read-only.

[ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartLegendFormat;

Property Value

height

Represents the height, in points, of the legend on the chart. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

height: number;

Property Value

number

left

Represents the left, in points, of a chart legend. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

left: number;

Property Value

number

legendEntries

Represents a collection of legendEntries in the legend. Read-only.

[ API set: ExcelApi 1.7 ]

readonly legendEntries: Excel.ChartLegendEntryCollection;

Property Value

overlay

Boolean value for whether the chart legend should overlap with the main body of the chart.

[ API set: ExcelApi 1.1 ]

overlay: boolean;

Property Value

boolean

position

Represents the position of the legend on the chart. See Excel.ChartLegendPosition for details.

[ API set: ExcelApi 1.1 ]

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

Property Value

Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"

showShadow

Represents if the legend has a shadow on the chart.

[ API set: ExcelApi 1.7 ]

showShadow: boolean;

Property Value

boolean

top

Represents the top of a chart legend.

[ API set: ExcelApi 1.7 ]

top: number;

Property Value

number

visible

A boolean value the represents the visibility of a ChartLegend object.

[ API set: ExcelApi 1.1 ]

visible: boolean;

Property Value

boolean

width

Represents the width, in points, of the legend on the chart. Null if legend is not visible.

[ API set: ExcelApi 1.7 ]

width: number;

Property Value

number

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?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;

Parameters

Returns

Remarks

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

load(option?: string | string[]): Excel.ChartLegend - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ChartLegend - 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.ChartLegend - 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.

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

Parameters

propertyNames
string | string[]

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

Returns

Examples

// Get the position of Chart Legend from Chart1
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    var legend = chart.legend;
    legend.load('position');
    return ctx.sync().then(function() {
            console.log(legend.position);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Set to show legend of Chart1 and make it on top of the chart.
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.legend.visible = true;
    chart.legend.position = "top"; 
    chart.legend.overlay = false; 
    return ctx.sync().then(function() {
            console.log("Legend Shown ");
    });
}).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.ChartLegend;

Parameters

propertyNamesAndPaths
{ select?: string; expand?: string; }

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

Parameters

properties
Interfaces.ChartLegendUpdateData

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

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ChartLegend): void;

Parameters

properties
Excel.ChartLegend

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

toJSON(): Excel.Interfaces.ChartLegendData;

Returns