Excel.Interfaces.ChartLegendLoadOptions interface

Package:

excel

Represents the legend in a chart.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
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.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

TypeScript

$all?: boolean;

Property Value

boolean

format

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

TypeScript

format?: Excel.Interfaces.ChartLegendFormatLoadOptions;

Property Value

Excel.Interfaces.ChartLegendFormatLoadOptions

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.

TypeScript

height?: boolean;

Property Value

boolean

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.

TypeScript

left?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

overlay

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

TypeScript

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.

TypeScript

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

showShadow

Specifies if the legend has a shadow on the chart.

TypeScript

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

top

Specifies the top of a chart legend.

TypeScript

top?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

visible

Specifies if the chart legend is visible.

TypeScript

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.

TypeScript

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]