Excel.Interfaces.ChartLegendData interface
Warning
This API is now deprecated.
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 |
left | Specifies the left value, in points, of the legend on the chart. Value is |
legend |
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 |
show |
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 |
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.ChartLegendFormatData;
Property Value
Remarks
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
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
legendEntries
Warning
This API is now deprecated.
Represents a collection of legendEntries in the legend.
legendEntries?: Excel.Interfaces.ChartLegendEntryData[];
Property Value
Remarks
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
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
showShadow
Warning
This API is now deprecated.
Specifies if the legend has a shadow on the chart.
showShadow?: boolean;
Property Value
boolean
Remarks
top
Warning
This API is now deprecated.
Specifies the top of a chart legend.
top?: number;
Property Value
number
Remarks
visible
Warning
This API is now deprecated.
Specifies if the chart legend is visible.
visible?: boolean;
Property Value
boolean
Remarks
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
Office Add-ins