Excel.ChartTitle class
グラフのグラフ タイトルのオブジェクトを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| format | 塗りつぶしとフォントの書式設定を含むグラフ タイトルの書式設定を表します。 |
| height | グラフ タイトルの高さ (ポイント数) を返します。 グラフタイトルが表示されない場合、値は |
| horizontal |
グラフ タイトルの水平方向の配置を指定します。 |
| left | グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は |
| overlay | グラフタイトルがグラフをオーバーレイするかどうかを指定します。 |
| position | グラフ タイトルの位置を表します。 詳細は「 |
| show |
グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。 |
| text | グラフのタイトル テキストを指定します。 |
| text |
グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。 |
| top | グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は |
| vertical |
グラフ タイトルの垂直方向の配置を指定します。 詳細は「 |
| visible | グラフのタイトルを表示するかどうかを指定します。 |
| width | グラフ タイトルの幅をポイント単位で指定します。 グラフタイトルが表示されない場合、値は |
メソッド
| get |
グラフ タイトルの部分文字列を取得します。 改行 '\n' は 1 文字をカウントします。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| set |
A1 スタイルの表記法を使用するグラフ タイトルの数式を表す文字列値を設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
format
塗りつぶしとフォントの書式設定を含むグラフ タイトルの書式設定を表します。
readonly format: Excel.ChartTitleFormat;プロパティ値
注釈
height
グラフ タイトルの高さ (ポイント数) を返します。 グラフタイトルが表示されない場合、値は null されます。
readonly height: number;プロパティ値
number
注釈
horizontalAlignment
グラフ タイトルの水平方向の配置を指定します。
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
注釈
left
グラフ タイトルの左端からグラフ領域の左端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
left: number;プロパティ値
number
注釈
overlay
position
グラフ タイトルの位置を表します。 詳細は「Excel.ChartTitlePosition」をご覧ください。
position: Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right";プロパティ値
Excel.ChartTitlePosition | "Automatic" | "Top" | "Bottom" | "Left" | "Right"
注釈
showShadow
グラフ タイトルが影付きにされるかどうかを指定するブール値を表します。
showShadow: boolean;プロパティ値
boolean
注釈
text
textOrientation
グラフタイトルのテキストの向きを指定します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。
textOrientation: number;プロパティ値
number
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const title = sheet.charts.getItemAt(0).title;
title.textOrientation = -45;
await context.sync();
});
top
グラフ タイトルの上端からグラフ領域の上端までの距離をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
top: number;プロパティ値
number
注釈
verticalAlignment
グラフ タイトルの垂直方向の配置を指定します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
注釈
visible
width
グラフ タイトルの幅をポイント単位で指定します。 グラフタイトルが表示されない場合、値は null されます。
readonly width: number;プロパティ値
number
注釈
メソッドの詳細
getSubstring(start, length)
グラフ タイトルの部分文字列を取得します。 改行 '\n' は 1 文字をカウントします。
getSubstring(start: number, length: number): Excel.ChartFormatString;パラメーター
- start
-
number
取得する部分文字列の開始位置。 0 を起点とする番号になります。
- length
-
number
取得する部分文字列の長さ。
戻り値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-title-format.yaml
await Excel.run(async (context) => {
let sheet = context.workbook.worksheets.getItem("Sample");
let chart = sheet.charts.getItemAt(0);
// Get first seven characters of the title and color them green.
chart.title.getSubstring(0, 7).font.color = "Yellow";
await context.sync();
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartTitleLoadOptions): Excel.ChartTitle;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ChartTitle;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Set the text of the chart title to "My Chart" and display it as an overlay on the chart.
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.title.text= "My Chart";
chart.title.visible=true;
chart.title.overlay=true;
await context.sync();
console.log("Char Title Changed");
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartTitle;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartTitleUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ChartTitleUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartTitle): void;パラメーター
- properties
- Excel.ChartTitle
戻り値
void
setFormula(formula)
A1 スタイルの表記法を使用するグラフ タイトルの数式を表す文字列値を設定します。
setFormula(formula: string): void;パラメーター
- formula
-
string
設定する数式を表す文字列。
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartTitle オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartTitleData として型指定) を返します。
toJSON(): Excel.Interfaces.ChartTitleData;戻り値
Office Add-ins