次の方法で共有


Excel.ChartDataLabels class

グラフのポイントにあるすべてのデータ ラベルのコレクションを表します。

Extends

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

format

塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。

position

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

separator

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

showBubbleSize

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

showCategoryName

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

showLegendKey

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

showPercentage

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

showSeriesName

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

showValue

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

メソッド

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.ChartDataLabels オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartDataLabelsData として型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

format

塗りつぶしとフォントの書式設定を含むグラフ データ ラベルの形式を指定します。

readonly format: Excel.ChartDataLabelFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

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"

注釈

[ API セット: ExcelApi 1.1 ]

separator

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

separator: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.1 ]

showBubbleSize

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

showBubbleSize: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

showCategoryName

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

showCategoryName: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

showLegendKey

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

showLegendKey: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

showPercentage

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

showPercentage: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

showSeriesName

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

showSeriesName: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

showValue

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

showValue: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;

パラメーター

options
Excel.Interfaces.ChartDataLabelsLoadOptions

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

戻り値

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;

パラメーター

戻り値

void

toJSON()

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.ChartDataLabels オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.ChartDataLabelsData として型指定) を返します。

toJSON(): Excel.Interfaces.ChartDataLabelsData;

戻り値