ExcelScript.ChartTitle interface

パッケージ:

ExcelScript

グラフのグラフ タイトルのオブジェクトを表します。

注釈

使用元

• ExcelScript.Chart: getTitle

例

/**
 * This sample accesses and customizes the chart title.
 * 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];
  
  // Customize the title.
  const title = chart.getTitle();
  title.setText("Quarterly Sales by Product");
  title.setVisible(true);
}

メソッド

getFormat()	塗りつぶしとフォントの書式設定を含むグラフ タイトルの書式設定を表します。
getHeight()	グラフ タイトルの高さ (ポイント数) を返します。 グラフタイトルが表示されない場合、値は null されます。
getHorizontalAlignment()	グラフ タイトルの水平方向の配置を指定します。
getLeft()	グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
getOverlay()	グラフタイトルがグラフをオーバーレイするかどうかを指定します。
getPosition()	グラフ タイトルの位置を表します。 詳細は「ExcelScript.ChartTitlePosition」をご覧ください。
getShowShadow()	グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。
getSubstring(start, length)	グラフ タイトルの部分文字列を取得します。 改行 '\n' は 1 文字をカウントします。
getText()	グラフのタイトル テキストを指定します。
getTextOrientation()	グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。
getTop()	グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
getVerticalAlignment()	グラフ タイトルの垂直方向の配置を指定します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。
getVisible()	グラフのタイトルを表示するかどうかを指定します。
getWidth()	グラフ タイトルの幅をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
setFormula(formula)	A1 スタイルの表記法を使用するグラフ タイトルの数式を表す文字列値を設定します。
setHorizontalAlignment(horizontalAlignment)	グラフ タイトルの水平方向の配置を指定します。
setLeft(left)	グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
setOverlay(overlay)	グラフタイトルがグラフをオーバーレイするかどうかを指定します。
setPosition(position)	グラフ タイトルの位置を表します。 詳細は「ExcelScript.ChartTitlePosition」をご覧ください。
setShowShadow(showShadow)	グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。
setText(text)	グラフのタイトル テキストを指定します。
setTextOrientation(textOrientation)	グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。
setTop(top)	グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
setVerticalAlignment(verticalAlignment)	グラフ タイトルの垂直方向の配置を指定します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。
setVisible(visible)	グラフのタイトルを表示するかどうかを指定します。

メソッドの詳細

getFormat()

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

getFormat(): ChartTitleFormat;

返品

ExcelScript.ChartTitleFormat

getHeight()

グラフ タイトルの高さ (ポイント数) を返します。 グラフタイトルが表示されない場合、値は null されます。

getHeight(): number;

返品

number

getHorizontalAlignment()

グラフ タイトルの水平方向の配置を指定します。

getHorizontalAlignment(): ChartTextHorizontalAlignment;

返品

ExcelScript.ChartTextHorizontalAlignment

getLeft()

グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。

getLeft(): number;

返品

number

getOverlay()

グラフタイトルがグラフをオーバーレイするかどうかを指定します。

getOverlay(): boolean;

返品

boolean

getPosition()

グラフ タイトルの位置を表します。 詳細は「ExcelScript.ChartTitlePosition」をご覧ください。

getPosition(): ChartTitlePosition;

返品

ExcelScript.ChartTitlePosition

getShowShadow()

グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。

getShowShadow(): boolean;

返品

boolean

getSubstring(start, length)

グラフ タイトルの部分文字列を取得します。 改行 '\n' は 1 文字をカウントします。

getSubstring(start: number, length: number): ChartFormatString;

パラメーター

start

number

取得する部分文字列の開始位置。 0 を起点とする番号になります。

length

number

取得する部分文字列の長さ。

返品

ExcelScript.ChartFormatString

getText()

グラフのタイトル テキストを指定します。

getText(): string;

返品

string

getTextOrientation()

グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

getTextOrientation(): number;

返品

number

getTop()

グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。

getTop(): number;

返品

number

getVerticalAlignment()

グラフ タイトルの垂直方向の配置を指定します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。

getVerticalAlignment(): ChartTextVerticalAlignment;

返品

ExcelScript.ChartTextVerticalAlignment

getVisible()

グラフのタイトルを表示するかどうかを指定します。

getVisible(): boolean;

返品

boolean

getWidth()

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

getWidth(): number;

返品

number

setFormula(formula)

A1 スタイルの表記法を使用するグラフ タイトルの数式を表す文字列値を設定します。

setFormula(formula: string): void;

パラメーター

formula

string

設定する数式を表す文字列。

返品

void

setHorizontalAlignment(horizontalAlignment)

グラフ タイトルの水平方向の配置を指定します。

setHorizontalAlignment(
            horizontalAlignment: ChartTextHorizontalAlignment
        ): void;

パラメーター

horizontalAlignment

ExcelScript.ChartTextHorizontalAlignment

返品

void

setLeft(left)

グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。

setLeft(left: number): void;

パラメーター

left

number

返品

void

setOverlay(overlay)

グラフタイトルがグラフをオーバーレイするかどうかを指定します。

setOverlay(overlay: boolean): void;

パラメーター

overlay

boolean

返品

void

setPosition(position)

グラフ タイトルの位置を表します。 詳細は「ExcelScript.ChartTitlePosition」をご覧ください。

setPosition(position: ChartTitlePosition): void;

パラメーター

position

ExcelScript.ChartTitlePosition

返品

void

setShowShadow(showShadow)

グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。

setShowShadow(showShadow: boolean): void;

パラメーター

showShadow

boolean

返品

void

setText(text)

グラフのタイトル テキストを指定します。

setText(text: string): void;

パラメーター

text

string

返品

void

例

/**
 * This sample sets the chart title text.
 * 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];
  
  // Set the chart title.
  chart.getTitle().setText("Quarterly Sales by Product");
}

setTextOrientation(textOrientation)

グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。

setTextOrientation(textOrientation: number): void;

パラメーター

textOrientation

number

返品

void

setTop(top)

グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。

setTop(top: number): void;

パラメーター

top

number

返品

void

setVerticalAlignment(verticalAlignment)

グラフ タイトルの垂直方向の配置を指定します。 詳細は「ExcelScript.ChartTextVerticalAlignment」をご覧ください。

setVerticalAlignment(
            verticalAlignment: ChartTextVerticalAlignment
        ): void;

パラメーター

verticalAlignment

ExcelScript.ChartTextVerticalAlignment

返品

void

setVisible(visible)

グラフのタイトルを表示するかどうかを指定します。

setVisible(visible: boolean): void;

パラメーター

visible

boolean

返品

void