Excel.PivotTableStyle class

パッケージ:

excel

ピボットテーブル領域でスタイル要素を定義するピボットテーブル スタイルを表します。

Extends

OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.10 ]

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
name	ピボットテーブル スタイルの名前を指定します。
readOnly	この PivotTableStyle オブジェクトが読み取り専用かどうかを指定します。

メソッド

delete()	ピボットテーブル スタイルを削除します。
duplicate()	すべてのスタイル要素のコピーを使用して、このピボットテーブル スタイルの複製を作成します。
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.PivotTableStyle オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.PivotTableStyleData型指定) を返します。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Excel.RequestContext

name

ピボットテーブル スタイルの名前を指定します。

name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.10 ]

readOnly

この PivotTableStyle オブジェクトが読み取り専用かどうかを指定します。

readonly readOnly: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.10 ]

メソッドの詳細

delete()

ピボットテーブル スタイルを削除します。

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.10 ]

duplicate()

すべてのスタイル要素のコピーを使用して、このピボットテーブル スタイルの複製を作成します。

duplicate(): Excel.PivotTableStyle;

戻り値

Excel.PivotTableStyle

このピボットテーブル スタイルから複製された新しい PivotTableStyle オブジェクト。

注釈

[ API セット: ExcelApi 1.10 ]

load(options)

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

load(options?: Excel.Interfaces.PivotTableStyleLoadOptions): Excel.PivotTableStyle;

パラメーター

options

Excel.Interfaces.PivotTableStyleLoadOptions

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

戻り値

Excel.PivotTableStyle

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

Excel.PivotTableStyle

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

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

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

戻り値

Excel.PivotTableStyle

set(properties, options)

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

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

パラメーター

properties

Excel.Interfaces.PivotTableStyleUpdateData

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

options

OfficeExtension.UpdateOptions

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

戻り値

void

set(properties)

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

set(properties: Excel.PivotTableStyle): void;

パラメーター

properties

Excel.PivotTableStyle

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.PivotTableStyleData;

戻り値

Excel.Interfaces.PivotTableStyleData