Edit

Share via

Excel.Interfaces.ChartLegendUpdateData interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

An interface for updating data on the ChartLegend object, for use in chartLegend.set({ ... }).

Properties

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

format

Warning

This API is now deprecated.

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

format?: Excel.Interfaces.ChartLegendFormatUpdateData;

Property Value

Excel.Interfaces.ChartLegendFormatUpdateData

Remarks

[ API set: ExcelApi 1.1 ]

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

[ API set: ExcelApi 1.7 ]

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

[ API set: ExcelApi 1.7 ]

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

Warning

This API is now deprecated.

Specifies if the legend has a shadow on the chart.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

top

Warning

This API is now deprecated.

Specifies the top of a chart legend.

top?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

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 ]

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

[ API set: ExcelApi 1.7 ]