Excel.ChartDataLabels class
グラフのポイントにあるすべてのデータ ラベルのコレクションを表します。
- Extends
注釈
プロパティ
| auto |
データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| format | 塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。 |
| horizontal |
グラフ データ ラベルの水平方向の配置を指定します。 詳細は「 |
| link |
数値形式をセルにリンクするかどうかを指定します。
|
| number |
データ ラベルの書式コードを指定します。 |
| position | データ ラベルの位置を表す値。 詳細は「 |
| separator | グラフのデータ ラベルに使用される区切り文字を表す文字列を設定します。 |
| show |
データ ラベルのバブル サイズを表示するかどうかを指定します。 |
| show |
データ ラベル カテゴリ名を表示するかどうかを指定します。 |
| show |
データ ラベルの凡例キーを表示するかどうかを指定します。 |
| show |
データ ラベルの割合を表示するかどうかを指定します。 |
| show |
データ ラベル系列名を表示するかどうかを指定します。 |
| show |
データ ラベルの値を表示するかどうかを指定します。 |
| text |
データ ラベルのテキストの向きを示す角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。 |
| vertical |
グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
autoText
データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。
autoText: boolean;プロパティ値
boolean
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
format
塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。
readonly format: Excel.ChartDataLabelFormat;プロパティ値
注釈
horizontalAlignment
グラフ データ ラベルの水平方向の配置を指定します。 詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が 0 の場合にのみ有効です。
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
注釈
linkNumberFormat
数値形式をセルにリンクするかどうかを指定します。
true
した場合、セル内で数値形式が変更されるとラベルが変更されます。
linkNumberFormat: boolean;プロパティ値
boolean
注釈
numberFormat
position
データ ラベルの位置を表す値。 詳細は「Excel.ChartDataLabelPosition」をご覧ください。
position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";プロパティ値
Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
注釈
separator
showBubbleSize
データ ラベルのバブル サイズを表示するかどうかを指定します。
showBubbleSize: boolean;プロパティ値
boolean
注釈
showCategoryName
データ ラベル カテゴリ名を表示するかどうかを指定します。
showCategoryName: boolean;プロパティ値
boolean
注釈
showLegendKey
showPercentage
showSeriesName
showValue
textOrientation
データ ラベルのテキストの向きを示す角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。
textOrientation: number;プロパティ値
number
注釈
verticalAlignment
グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ChartDataLabels;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
// Show the series name in data labels and set the position of the data labels to "top".
await Excel.run(async (context) => {
const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
chart.dataLabels.showValue = true;
chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
chart.dataLabels.showSeriesName = true;
await context.sync();
console.log("Data labels shown");
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartDataLabels;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ChartDataLabelsUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartDataLabels): void;パラメーター
- properties
- Excel.ChartDataLabels
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartDataLabels オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartDataLabelsData として型指定) を返します。
toJSON(): Excel.Interfaces.ChartDataLabelsData;戻り値
Office Add-ins