Excel.Interfaces.ChartLegendLoadOptions interface

Represents the legend in a chart.

[ API set: ExcelApi 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

format

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

[ 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 ]

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 ]

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

format

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

[ API set: ExcelApi 1.1 ]

format?: Excel.Interfaces.ChartLegendFormatLoadOptions;

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?: boolean;

Property Value

boolean

left

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

[ API set: ExcelApi 1.7 ]

left?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean