ExcelScript.ChartLegend interface

表示图表图例的格式，包括填充和字体格式。

getFormat(): ChartLegendFormat;

返回

指定图表上图例的高度（以磅为单位）。 null如果图例不可见，则值为 。

getHeight(): number;

返回

指定图表上图例的左值（以磅为单位）。 null如果图例不可见，则值为 。

getLeft(): number;

返回

表示图例中 legendEntries 的集合。

getLegendEntries(): ChartLegendEntry[];

返回

指定图表图例是否应与图表的主体重叠。

getOverlay(): boolean;

返回

指定图例在图表上的位置。 有关详细信息，请参阅 ExcelScript.ChartLegendPosition。

getPosition(): ChartLegendPosition;

返回

指定图例在图表上是否有阴影。

getShowShadow(): boolean;

返回

指定图表图例的顶部。

getTop(): number;

返回

指定图表图例是否可见。

getVisible(): boolean;

返回

指定图表上图例的宽度（以磅为单位）。 null如果图例不可见，则值为 。

getWidth(): number;

返回

指定图表上图例的高度（以磅为单位）。 null如果图例不可见，则值为 。

setHeight(height: number): void;

参数

返回

指定图表上图例的左值（以磅为单位）。 null如果图例不可见，则值为 。

setLeft(left: number): void;

参数

返回

指定图表图例是否应与图表的主体重叠。

setOverlay(overlay: boolean): void;

参数

返回

指定图例在图表上的位置。 有关详细信息，请参阅 ExcelScript.ChartLegendPosition。

setPosition(position: ChartLegendPosition): void;

参数

返回

示例

/**
 * This sample sets the legend position on a chart.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Position the legend on the right side.
  chart.getLegend().setPosition(ExcelScript.ChartLegendPosition.right);
}

指定图例在图表上是否有阴影。

setShowShadow(showShadow: boolean): void;

参数

返回

指定图表图例的顶部。

setTop(top: number): void;

参数

返回

指定图表图例是否可见。

setVisible(visible: boolean): void;

参数

返回

示例

/**
 * This sample hides the chart legend.
 * This assumes the active worksheet has a chart.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first chart on the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const chart = sheet.getCharts()[0];
  
  // Hide the legend.
  chart.getLegend().setVisible(false);
}

指定图表上图例的宽度（以磅为单位）。 null如果图例不可见，则值为 。

setWidth(width: number): void;

参数

返回