Excel.ChartDataLabel class

パッケージ:: excel

グラフポイントのデータラベルを表します。

Extends: OfficeExtension.ClientObject

注釈

例

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

プロパティ

autoText	データラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
format	グラフのデータラベルの書式設定を表します。
formula	A1 スタイルの表記法を使用するグラフのデータラベルの数式を表す文字列値。
height	グラフのデータラベルの高さ (ポイント数) を返します。グラフデータラベルが表示されない場合、値は `null` されます。
horizontalAlignment	グラフのデータラベルの水平方向の配置を表します。詳細は「`Excel.ChartTextHorizontalAlignment`」をご覧ください。このプロパティは、データラベルの `TextOrientation` が -90、90、または 180 の場合にのみ有効です。
left	グラフのデータラベルの左端からグラフエリアの左端までの距離 (ポイント数) を表します。グラフデータラベルが表示されない場合、値は `null` されます。
numberFormat	データラベルの書式コードを指定します。
position	データラベルの位置を表す値。詳細は「`Excel.ChartDataLabelPosition`」をご覧ください。
separator	グラフのデータラベルに使用される区切り文字を表す文字列。
showBubbleSize	データラベルのバブルサイズを表示するかどうかを指定します。
showCategoryName	データラベルカテゴリ名を表示するかどうかを指定します。
showLegendKey	データラベルの凡例キーを表示するかどうかを指定します。
showPercentage	データラベルの割合を表示するかどうかを指定します。
showSeriesName	データラベル系列名を表示するかどうかを指定します。
showValue	データラベルの値を表示するかどうかを指定します。
text	グラフのデータラベルのテキストを表す文字列。
textOrientation	グラフデータラベルのテキストの向きを表す角度を表します。値は、-90 から 90 までの整数、または垂直方向のテキストの場合は整数 180 である必要があります。
top	グラフのデータラベルの上端からグラフエリアの上端までの距離 (ポイント数) を表します。グラフデータラベルが表示されない場合、値は `null` されます。
verticalAlignment	グラフのデータラベルの垂直方向の配置を表します。詳細は「`Excel.ChartTextVerticalAlignment`」をご覧ください。このプロパティは、データラベルの `TextOrientation` が 0 の場合にのみ有効です。
width	グラフのデータラベルの幅 (ポイント数) を返します。グラフデータラベルが表示されない場合、値は `null` されます。

メソッド

load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Excel.ChartDataLabel` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Excel.Interfaces.ChartDataLabelData` として型指定) を返します。

プロパティの詳細

autoText

データラベルがコンテキストに基づいて適切なテキストを自動的に生成するかどうかを指定します。

autoText: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

format

グラフのデータラベルの書式設定を表します。

readonly format: Excel.ChartDataLabelFormat;

プロパティ値

Excel.ChartDataLabelFormat

注釈

[ API セット: ExcelApi 1.8 ]

formula

A1 スタイルの表記法を使用するグラフのデータラベルの数式を表す文字列値。

formula: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

height

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

readonly height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

horizontalAlignment

グラフのデータラベルの水平方向の配置を表します。詳細は「Excel.ChartTextHorizontalAlignment」をご覧ください。このプロパティは、データラベルの TextOrientation が -90、90、または 180 の場合にのみ有効です。

horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" | "Distributed";

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

left

グラフのデータラベルの左端からグラフエリアの左端までの距離 (ポイント数) を表します。グラフデータラベルが表示されない場合、値は null されます。

left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

numberFormat

データラベルの書式コードを指定します。

numberFormat: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

position

データラベルの位置を表す値。詳細は「Excel.ChartDataLabelPosition」をご覧ください。

position: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

separator

グラフのデータラベルに使用される区切り文字を表す文字列。

separator: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

showBubbleSize

データラベルのバブルサイズを表示するかどうかを指定します。

showBubbleSize: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

showCategoryName

データラベルカテゴリ名を表示するかどうかを指定します。

showCategoryName: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

showLegendKey

データラベルの凡例キーを表示するかどうかを指定します。

showLegendKey: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

showPercentage

データラベルの割合を表示するかどうかを指定します。

showPercentage: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

showSeriesName

データラベル系列名を表示するかどうかを指定します。

showSeriesName: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

showValue

データラベルの値を表示するかどうかを指定します。

showValue: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

text

グラフのデータラベルのテキストを表す文字列。

text: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.8 ]

textOrientation

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

textOrientation: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

top

グラフのデータラベルの上端からグラフエリアの上端までの距離 (ポイント数) を表します。グラフデータラベルが表示されない場合、値は null されます。

top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

verticalAlignment

グラフのデータラベルの垂直方向の配置を表します。詳細は「Excel.ChartTextVerticalAlignment」をご覧ください。このプロパティは、データラベルの TextOrientation が 0 の場合にのみ有効です。

verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

width

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

readonly width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

メソッドの詳細

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ChartDataLabelLoadOptions): Excel.ChartDataLabel;

パラメーター

options: Excel.Interfaces.ChartDataLabelLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.ChartDataLabel

load(propertyNames)

load(propertyNames?: string | string[]): Excel.ChartDataLabel;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.ChartDataLabel

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ChartDataLabel;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.ChartDataLabel

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Excel.Interfaces.ChartDataLabelUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

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;

戻り値

Excel.Interfaces.ChartDataLabelData

フィードバック

このページはお役に立ちましたか?

次の方法で共有

Excel.ChartDataLabel class

注釈

例

プロパティ

メソッド

プロパティの詳細

autoText

プロパティ値

注釈

context

プロパティ値

format

プロパティ値

注釈

formula

プロパティ値

注釈

height

プロパティ値

注釈

horizontalAlignment

プロパティ値

注釈

left

プロパティ値

注釈

numberFormat

プロパティ値

注釈

position

プロパティ値

注釈

separator

プロパティ値

注釈

showBubbleSize

プロパティ値

注釈

showCategoryName

プロパティ値

注釈

showLegendKey

プロパティ値

注釈

showPercentage

プロパティ値

注釈

showSeriesName

プロパティ値

注釈

showValue

プロパティ値

注釈

text

プロパティ値

注釈

textOrientation

プロパティ値

注釈

top

プロパティ値

注釈

verticalAlignment

プロパティ値

注釈

width

プロパティ値

注釈

メソッドの詳細

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

set(properties, options)