ExcelScript.ChartLegend interface

塗りつぶしとフォントの書式設定を含むグラフの凡例の書式設定を表します。

getFormat(): ChartLegendFormat;

戻り値

グラフの凡例の高さをポイント単位で指定します。 凡例が表示されない場合、値は null されます。

getHeight(): number;

戻り値

グラフの凡例の左の値をポイント単位で指定します。 凡例が表示されない場合、値は null されます。

getLeft(): number;

戻り値

凡例に含まれる凡例エントリのコレクションを表します。

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;

パラメーター

戻り値