Excel.ChartPlotArea class

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

Extends

プロパティ

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 オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、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

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

返品

void

set(properties)

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

set(properties: Excel.ChartPlotArea): void;

パラメーター

properties
Excel.ChartPlotArea

返品

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartPlotAreaData;

返品