Excel.ChartLegend class
Warning
This API is now deprecated.
Represents the legend in a chart.
- Extends
Remarks
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 |
left | Specifies the left value, in points, of the legend on the chart. Value is |
legend |
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 |
show |
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 |
Methods
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
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 |
Property Details
context
Warning
This API is now deprecated.
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
Warning
This API is now deprecated.
Represents the formatting of a chart legend, which includes fill and font formatting.
readonly format: Excel.ChartLegendFormat;
Property Value
Remarks
height
Warning
This API is now deprecated.
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
left
Warning
This API is now deprecated.
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
legendEntries
Warning
This API is now deprecated.
Represents a collection of legendEntries in the legend.
readonly legendEntries: Excel.ChartLegendEntryCollection;
Property Value
Remarks
overlay
Warning
This API is now deprecated.
Specifies if the chart legend should overlap with the main body of the chart.
overlay: boolean;
Property Value
boolean
Remarks
position
Warning
This API is now deprecated.
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
showShadow
Warning
This API is now deprecated.
Specifies if the legend has a shadow on the chart.
showShadow: boolean;
Property Value
boolean
Remarks
top
Warning
This API is now deprecated.
Specifies the top of a chart legend.
top: number;
Property Value
number
Remarks
visible
Warning
This API is now deprecated.
Specifies if the chart legend is visible.
visible: boolean;
Property Value
boolean
Remarks
width
Warning
This API is now deprecated.
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
Method Details
load(options)
Warning
This API is now deprecated.
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
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Warning
This API is now deprecated.
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.
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)
Warning
This API is now deprecated.
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
set(properties, options)
Warning
This API is now deprecated.
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)
Warning
This API is now deprecated.
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()
Warning
This API is now deprecated.
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
Office Add-ins