Excel.ChartPivotOptions class

ピボット グラフのオプションをカプセル化します。

Extends

プロパティ

context

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

showAxisFieldButtons

ピボットグラフに軸フィールド ボタンを表示するかどうかを指定します。 showAxisFieldButtons プロパティは、[分析] タブの [フィールド ボタン] ドロップダウン リストにある [軸フィールド ボタンの表示] コマンドに対応し、ピボットグラフが選択されている場合に表示されます。

showLegendFieldButtons

ピボットグラフに凡例フィールド ボタンを表示するかどうかを指定します。

showReportFilterFieldButtons

ピボットグラフにレポート フィルター フィールドのボタンを表示するかどうかを指定します。

showValueFieldButtons

ピボットグラフに [値フィールドの表示] ボタンを表示するかどうかを指定します。

メソッド

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

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

showAxisFieldButtons

ピボットグラフに軸フィールド ボタンを表示するかどうかを指定します。 showAxisFieldButtons プロパティは、[分析] タブの [フィールド ボタン] ドロップダウン リストにある [軸フィールド ボタンの表示] コマンドに対応し、ピボットグラフが選択されている場合に表示されます。

showAxisFieldButtons: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

showLegendFieldButtons

ピボットグラフに凡例フィールド ボタンを表示するかどうかを指定します。

showLegendFieldButtons: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

showReportFilterFieldButtons

ピボットグラフにレポート フィルター フィールドのボタンを表示するかどうかを指定します。

showReportFilterFieldButtons: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

showValueFieldButtons

ピボットグラフに [値フィールドの表示] ボタンを表示するかどうかを指定します。

showValueFieldButtons: boolean;

プロパティ値

boolean

注釈

API セット: ExcelApi 1.9

メソッドの詳細

load(options)

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

load(options?: Excel.Interfaces.ChartPivotOptionsLoadOptions): Excel.ChartPivotOptions;

パラメーター

options
Excel.Interfaces.ChartPivotOptionsLoadOptions

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

返品

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.ChartPivotOptionsUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

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

返品

void

set(properties)

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

set(properties: Excel.ChartPivotOptions): void;

パラメーター

返品

void

toJSON()

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

toJSON(): Excel.Interfaces.ChartPivotOptionsData;

返品