ExcelScript.ChartLegend interface

パッケージ:

ExcelScript

グラフに凡例を表します。

注釈

使用元

• ExcelScript.Chart: getLegend

例

/**
 * This sample configures 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];
  
  // Configure the legend.
  const legend = chart.getLegend();
  legend.setPosition(ExcelScript.ChartLegendPosition.bottom);
  legend.setVisible(true);
}

メソッド

getFormat()	塗りつぶしとフォントの書式設定を含むグラフの凡例の書式設定を表します。
getHeight()	グラフの凡例の高さをポイント単位で指定します。 凡例が表示されない場合、値は null されます。
getLeft()	グラフの凡例の左の値をポイント単位で指定します。 凡例が表示されない場合、値は null されます。
getLegendEntries()	凡例に含まれる凡例エントリのコレクションを表します。
getOverlay()	グラフの凡例がグラフの本体と重複するかどうかを指定します。
getPosition()	グラフ上の凡例の位置を指定します。 詳細は「ExcelScript.ChartLegendPosition」をご覧ください。
getShowShadow()	凡例にグラフに影があるかどうかを指定します。
getTop()	グラフの凡例の上部を指定します。
getVisible()	グラフの凡例を表示するかどうかを指定します。
getWidth()	グラフの凡例の幅をポイント単位で指定します。 凡例が表示されない場合、値は null されます。
setHeight(height)	グラフの凡例の高さをポイント単位で指定します。 凡例が表示されない場合、値は null されます。
setLeft(left)	グラフの凡例の左の値をポイント単位で指定します。 凡例が表示されない場合、値は null されます。
setOverlay(overlay)	グラフの凡例がグラフの本体と重複するかどうかを指定します。
setPosition(position)	グラフ上の凡例の位置を指定します。 詳細は「ExcelScript.ChartLegendPosition」をご覧ください。
setShowShadow(showShadow)	凡例にグラフに影があるかどうかを指定します。
setTop(top)	グラフの凡例の上部を指定します。
setVisible(visible)	グラフの凡例を表示するかどうかを指定します。
setWidth(width)	グラフの凡例の幅をポイント単位で指定します。 凡例が表示されない場合、値は null されます。

メソッドの詳細

getFormat()

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

getFormat(): ChartLegendFormat;

返品

ExcelScript.ChartLegendFormat

getHeight()

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

getHeight(): number;

返品

number

getLeft()

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

getLeft(): number;

返品

number

getLegendEntries()

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

getLegendEntries(): ChartLegendEntry[];

返品

ExcelScript.ChartLegendEntry[]

getOverlay()

グラフの凡例がグラフの本体と重複するかどうかを指定します。

getOverlay(): boolean;

返品

boolean

getPosition()

グラフ上の凡例の位置を指定します。 詳細は「ExcelScript.ChartLegendPosition」をご覧ください。

getPosition(): ChartLegendPosition;

返品

ExcelScript.ChartLegendPosition

getShowShadow()

凡例にグラフに影があるかどうかを指定します。

getShowShadow(): boolean;

返品

boolean

getTop()

グラフの凡例の上部を指定します。

getTop(): number;

返品

number

getVisible()

グラフの凡例を表示するかどうかを指定します。

getVisible(): boolean;

返品

boolean

getWidth()

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

getWidth(): number;

返品

number

setHeight(height)

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

setHeight(height: number): void;

パラメーター

height

number

返品

void

setLeft(left)

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

setLeft(left: number): void;

パラメーター

left

number

返品

void

setOverlay(overlay)

グラフの凡例がグラフの本体と重複するかどうかを指定します。

setOverlay(overlay: boolean): void;

パラメーター

overlay

boolean

返品

void

setPosition(position)

グラフ上の凡例の位置を指定します。 詳細は「ExcelScript.ChartLegendPosition」をご覧ください。

setPosition(position: ChartLegendPosition): void;

パラメーター

position

ExcelScript.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)

凡例にグラフに影があるかどうかを指定します。

setShowShadow(showShadow: boolean): void;

パラメーター

showShadow

boolean

返品

void

setTop(top)

グラフの凡例の上部を指定します。

setTop(top: number): void;

パラメーター

top

number

返品

void

setVisible(visible)

グラフの凡例を表示するかどうかを指定します。

setVisible(visible: boolean): void;

パラメーター

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);
}

setWidth(width)

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

setWidth(width: number): void;

パラメーター

width

number

返品

void