Excel.Interfaces.ChartLegendData interface

Package:

excel

An interface describing the data returned by calling chartLegend.toJSON().

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

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

format?: Excel.Interfaces.ChartLegendFormatData;

Property Value

Excel.Interfaces.ChartLegendFormatData

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.

height?: number;

Property Value

number

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.

left?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

legendEntries

Represents a collection of legendEntries in the legend.

legendEntries?: Excel.Interfaces.ChartLegendEntryData[];

Property Value

Excel.Interfaces.ChartLegendEntryData[]

Remarks

[ API set: ExcelApi 1.7 ]

overlay

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

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

Specifies if the legend has a shadow on the chart.

showShadow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

top

Specifies the top of a chart legend.

top?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]

visible

Specifies if the chart legend is visible.

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.

width?: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.7 ]