Excel.ChartLegend class

Package:

excel

Represents the legend in a chart.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.1 ]

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.
height	Specifies the height, in points, of the legend on the chart. Value is null if the legend is not visible.
left	Specifies the left value, in points, of the legend on the chart. Value is null if the legend is not visible.
legendEntries	Represents a collection of legendEntries in the legend.
overlay	Specifies if the chart legend should overlap with the main body of the chart.
position	Specifies the position of the legend on the chart. See Excel.ChartLegendPosition for details.
showShadow	Specifies if the legend has a shadow on the chart.
top	Specifies the top of a chart legend.
visible	Specifies if the chart legend is visible.
width	Specifies the width, in points, of the legend on the chart. Value is null if the legend is not visible.

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

Excel.RequestContext

format

Represents the formatting of a chart legend, which includes fill and font formatting.

readonly format: Excel.ChartLegendFormat;

Property Value

Excel.ChartLegendFormat

Remarks

[ API set: ExcelApi 1.1 ]

height

Specifies the height, in points, of the legend on the chart. Value is null if the legend is not visible.

height: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

left

Specifies the left value, in points, of the legend on the chart. Value is null if the legend is not visible.

left: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

legendEntries

Represents a collection of legendEntries in the legend.

readonly legendEntries: Excel.ChartLegendEntryCollection;

Property Value

Excel.ChartLegendEntryCollection

Remarks

[ API set: ExcelApi 1.7 ]

overlay

Specifies if the chart legend should overlap with the main body of the chart.

overlay: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

position

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

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

Property Value

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

Remarks

[ API set: ExcelApi 1.1 ]

showShadow

Specifies if the legend has a shadow on the chart.

showShadow: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

top

Specifies the top of a chart legend.

top: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

visible

Specifies if the chart legend is visible.

visible: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

width

Specifies the width, in points, of the legend on the chart. Value is null if the legend is not visible.

width: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

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

Parameters

options

Excel.Interfaces.ChartLegendLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ChartLegend

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

Excel.ChartLegend

Examples

// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const legend = chart.legend;
    legend.load('position');
    await context.sync();

    console.log(legend.position);
});

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

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

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

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

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

Excel.Interfaces.ChartLegendData