Excel.Interfaces.ChartLegendLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

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

Specifies if the chart legend is visible.

Property Details

$all

Warning

This API is now deprecated.

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

$all?: boolean;

Property Value

boolean

format

Warning

This API is now deprecated.

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

format?: Excel.Interfaces.ChartLegendFormatLoadOptions;

Property Value

Excel.Interfaces.ChartLegendFormatLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

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

[ API set: ExcelApi 1.1 ]

position

Warning

This API is now deprecated.

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

position?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

visible

Warning

This API is now deprecated.

Specifies if the chart legend is visible.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]