Excel.ChartLegend class

  • リファレンス
パッケージ:
excel

グラフに凡例を表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

context

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

塗りつぶしとフォントの書式設定を含むグラフの凡例の書式設定を表します。
height

グラフの凡例の高さをポイント単位で指定します。 凡例が表示されない場合、値は null です。
left

グラフの凡例の左の値をポイント単位で指定します。 凡例が表示されない場合、値は null です。
legendEntries

凡例に含まれる凡例エントリのコレクションを表します。
overlay

グラフの凡例がグラフの本体と重複するかどうかを指定します。
position

グラフ上の凡例の位置を指定します。 詳細は「Excel.ChartLegendPosition」をご覧ください。
showShadow

凡例にグラフに影があるかどうかを指定します。
top

グラフの凡例の上部を指定します。
visible

グラフの凡例を表示するかどうかを指定します。
width

グラフの凡例の幅をポイント単位で指定します。 凡例が表示されない場合、値は null です。

メソッド

load(options)

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

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

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

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

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
toJSON()

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

format

塗りつぶしとフォントの書式設定を含むグラフの凡例の書式設定を表します。

readonly format: Excel.ChartLegendFormat;

プロパティ値

Excel.ChartLegendFormat

注釈

[ API セット: ExcelApi 1.1 ]

height

グラフの凡例の高さをポイント単位で指定します。 凡例が表示されない場合、値は null です。

height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

left

グラフの凡例の左の値をポイント単位で指定します。 凡例が表示されない場合、値は null です。

left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

legendEntries

凡例に含まれる凡例エントリのコレクションを表します。

readonly legendEntries: Excel.ChartLegendEntryCollection;

プロパティ値

Excel.ChartLegendEntryCollection

注釈

[ API セット: ExcelApi 1.7 ]

overlay

グラフの凡例がグラフの本体と重複するかどうかを指定します。

overlay: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

position

グラフ上の凡例の位置を指定します。 詳細は「Excel.ChartLegendPosition」をご覧ください。

position: Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom";

プロパティ値

Excel.ChartLegendPosition | "Invalid" | "Top" | "Bottom" | "Left" | "Right" | "Corner" | "Custom"

注釈

[ API セット: ExcelApi 1.1 ]

showShadow

凡例にグラフに影があるかどうかを指定します。

showShadow: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

top

グラフの凡例の上部を指定します。

top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

visible

グラフの凡例を表示するかどうかを指定します。

visible: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

width

グラフの凡例の幅をポイント単位で指定します。 凡例が表示されない場合、値は null です。

width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartLegendLoadOptions): Excel.ChartLegend;

パラメーター

options
Excel.Interfaces.ChartLegendLoadOptions

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

戻り値

Excel.ChartLegend

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.ChartLegend

例

// Get the position of Chart Legend from Chart1.
await Excel.run(async (context) => { 
    const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    const legend = chart.legend;
    legend.load('position');
    await context.sync();

    console.log(legend.position);
});

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.ChartLegend

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartLegendUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ChartLegend): void;

パラメーター

properties
Excel.ChartLegend

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendData;

戻り値

Excel.Interfaces.ChartLegendData