Excel.ChartPlotArea class

このオブジェクトは、グラフ プロット領域の属性を表します。

Extends

注釈

[ API セット: ExcelApi 1.8 ]

プロパティ

context

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

format

グラフ プロット領域の書式設定を指定します。

height

プロット領域の高さの値を指定します。

insideHeight

プロット領域の内側の高さの値を指定します。

insideLeft

プロット領域の内側の左の値を指定します。

insideTop

プロット領域の内側の上端の値を指定します。

insideWidth

プロット領域の内側の幅の値を指定します。

left

プロット領域の左の値を指定します。

position

プロット領域の位置を指定します。

top

プロット領域の最上位の値を指定します。

width

プロット領域の幅の値を指定します。

メソッド

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

format

グラフ プロット領域の書式設定を指定します。

readonly format: Excel.ChartPlotAreaFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.8 ]

height

プロット領域の高さの値を指定します。

height: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

insideHeight

プロット領域の内側の高さの値を指定します。

insideHeight: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

insideLeft

プロット領域の内側の左の値を指定します。

insideLeft: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

insideTop

プロット領域の内側の上端の値を指定します。

insideTop: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

insideWidth

プロット領域の内側の幅の値を指定します。

insideWidth: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

left

プロット領域の左の値を指定します。

left: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

position

プロット領域の位置を指定します。

position: Excel.ChartPlotAreaPosition | "Automatic" | "Custom";

プロパティ値

Excel.ChartPlotAreaPosition | "Automatic" | "Custom"

注釈

[ API セット: ExcelApi 1.8 ]

top

プロット領域の最上位の値を指定します。

top: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

width

プロット領域の幅の値を指定します。

width: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartPlotAreaLoadOptions): Excel.ChartPlotArea;

パラメーター

options
Excel.Interfaces.ChartPlotAreaLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartPlotAreaUpdateData

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

options
OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.ChartPlotArea): void;

パラメーター

properties
Excel.ChartPlotArea

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartPlotAreaData;

戻り値