Excel.ChartDataLabel class
グラフ上のポイントのデータ ラベルを表します。
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
// This function styles substrings within data label text using font formatting.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem(sheetName);
const chart = sheet.charts.getItemAt(0);
await context.sync();
const series = chart.series.getItemAt(0);
series.load("points");
await context.sync();
series.points.load("items");
await context.sync();
// Style a substring in the first data label.
let searchString = "sports";
let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
await context.sync();
let substringStart = dataLabel.text.indexOf(searchString);
let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.size = 13;
subLabel.font.bold = true;
// Style a substring in the second data label.
searchString = "'Titanic'";
dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
await context.sync();
substringStart = dataLabel.text.indexOf(searchString);
subLabel = dataLabel.getSubstring(substringStart, searchString.length);
subLabel.font.name = "Calibri";
subLabel.font.size = 13;
subLabel.font.italic = true;
subLabel.font.color = "blue";
await context.sync();
});
プロパティ
| auto |
データ ラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| format | グラフのデータ ラベルの書式設定を表します。 |
| formula | A1 スタイルの表記法を使用するグラフのデータ ラベルの数式を表す文字列値。 |
| height | グラフのデータ ラベルの高さ (ポイント数) を返します。 グラフのデータ ラベルが表示されない場合は、値が |
| horizontal |
グラフのデータ ラベルの水平方向の配置を表します。 詳細は「 |
| left | グラフのデータ ラベルの左端からグラフ エリアの左端までの距離 (ポイント数) を表します。 グラフのデータ ラベルが表示されない場合は、値が |
| link |
数値の表示形式をセルにリンクするかどうかを指定します (これにより、数値の表示形式がセル内で変更されるときにラベルの表示形式が変更されるようにします)。 |
| number |
データ ラベルのフォーマット コードを指定します。 |
| position | データ ラベルの位置を表す値。 詳細は「 |
| separator | グラフのデータ ラベルに使用される区切り文字を表す文字列。 |
| show |
データ ラベルのバブル サイズを表示するかどうかを指定します。 |
| show |
データ ラベル カテゴリ名を表示するかどうかを指定します。 |
| show |
データ ラベルの凡例キーを表示するかどうかを指定します。 |
| show |
データ ラベルのパーセンテージを表示するかどうかを指定します。 |
| show |
データ ラベル系列名を表示するかどうかを指定します。 |
| show |
データ ラベルの値が表示されるかどうかを指定します。 |
| text | グラフのデータ ラベルのテキストを表す文字列。 |
| text |
グラフのデータ ラベルに対してテキストが配置される角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は 180 の整数にする必要があります。 |
| top | グラフのデータ ラベルの上端からグラフ エリアの上端までの距離 (ポイント数) を表します。 グラフのデータ ラベルが表示されない場合は、値が |
| vertical |
グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「 |
| width | グラフのデータ ラベルの幅 (ポイント数) を返します。 グラフのデータ ラベルが表示されない場合は、値が |
メソッド
| 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;プロパティ値
注釈
formula
height
グラフのデータ ラベルの高さ (ポイント数) を返します。 グラフのデータ ラベルが表示されない場合は、値が null されます。
readonly height: number;プロパティ値
number
注釈
horizontalAlignment
グラフのデータ ラベルの水平方向の配置を表します。 詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。
horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed"
注釈
left
グラフのデータ ラベルの左端からグラフ エリアの左端までの距離 (ポイント数) を表します。 グラフのデータ ラベルが表示されない場合は、値が null されます。
left: number;プロパティ値
number
注釈
linkNumberFormat
数値の表示形式をセルにリンクするかどうかを指定します (これにより、数値の表示形式がセル内で変更されるときにラベルの表示形式が変更されるようにします)。
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
showCategoryName
showLegendKey
showPercentage
showSeriesName
showValue
text
textOrientation
グラフのデータ ラベルに対してテキストが配置される角度を表します。 値は、-90 から 90 までの整数、または垂直方向のテキストの場合は 180 の整数にする必要があります。
textOrientation: number;プロパティ値
number
注釈
top
グラフのデータ ラベルの上端からグラフ エリアの上端までの距離 (ポイント数) を表します。 グラフのデータ ラベルが表示されない場合は、値が null されます。
top: number;プロパティ値
number
注釈
verticalAlignment
グラフのデータ ラベルの垂直方向の配置を表します。 詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。 このプロパティは、データ ラベルの TextOrientation が 0 の場合にのみ有効です。
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";プロパティ値
Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed"
注釈
width
グラフのデータ ラベルの幅 (ポイント数) を返します。 グラフのデータ ラベルが表示されない場合は、値が null されます。
readonly width: number;プロパティ値
number
注釈
メソッドの詳細
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.ChartDataLabel;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ChartDataLabel;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Excel.Interfaces.ChartDataLabelUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.ChartDataLabel): void;パラメーター
- properties
- Excel.ChartDataLabel
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartDataLabel オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartDataLabelData と型指定) を返します。
toJSON(): Excel.Interfaces.ChartDataLabelData;