Excel.ChartLegendEntry class

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

legendEntryCollection の凡例エントリを表します。

Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

context

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

グラフの凡例の凡例エントリの高さを指定します。
index

グラフの凡例の凡例エントリのインデックスを指定します。
left

グラフの凡例エントリの左の値を指定します。
top

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

グラフの凡例エントリの表示を表します。
width

グラフ凡例の凡例エントリの幅を表します。

メソッド

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

height

グラフの凡例の凡例エントリの高さを指定します。

readonly height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

index

グラフの凡例の凡例エントリのインデックスを指定します。

readonly index: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

left

グラフの凡例エントリの左の値を指定します。

readonly left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

top

グラフの凡例エントリの上部を指定します。

readonly top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

visible

グラフの凡例エントリの表示を表します。

visible: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

width

グラフ凡例の凡例エントリの幅を表します。

readonly width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartLegendEntryLoadOptions): Excel.ChartLegendEntry;

パラメーター

options
Excel.Interfaces.ChartLegendEntryLoadOptions

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

戻り値

Excel.ChartLegendEntry

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.ChartLegendEntry

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.ChartLegendEntry

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartLegendEntryUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.ChartLegendEntry): void;

パラメーター

properties
Excel.ChartLegendEntry

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartLegendEntryData;

戻り値

Excel.Interfaces.ChartLegendEntryData