Excel.PivotTableStyleCollection class
ピボットテーブル スタイルのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(name, make |
指定した名前の空白の |
| get |
コレクションに含まれる PivotTableStyle の数を取得します。 |
| get |
親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。 |
| get |
名前で |
| get |
名前で |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: Excel.PivotTableStyle[];プロパティ値
メソッドの詳細
add(name, makeUniqueName)
指定した名前の空白の PivotTableStyle を作成します。
add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle;パラメーター
- name
-
string
新しいピボットテーブル スタイルの一意の名前。 名前が既に使用されている場合は、 InvalidArgument エラーをスローします。
- makeUniqueName
-
boolean
省略可能。 既定値は false です。
true
場合は、必要に応じて一意にするために、名前に番号を追加します。
戻り値
新しく作成された PivotTableStyle。
注釈
getCount()
コレクションに含まれる PivotTableStyle の数を取得します。
getCount(): OfficeExtension.ClientResult<number>;戻り値
OfficeExtension.ClientResult<number>
注釈
getDefault()
親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。
getDefault(): Excel.PivotTableStyle;戻り値
現在の既定のピボットテーブル スタイルである PivotTableStyle オブジェクト。
注釈
getItem(name)
名前で PivotTableStyle を取得します。
getItem(name: string): Excel.PivotTableStyle;パラメーター
- name
-
string
取得するピボットテーブル スタイルの名前。
戻り値
名前が入力と一致する PivotTableStyle オブジェクト。
注釈
getItemOrNullObject(name)
名前で PivotTableStyle を取得します。
PivotTableStyleが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getItemOrNullObject(name: string): Excel.PivotTableStyle;パラメーター
- name
-
string
取得するピボットテーブル スタイルの名前。
戻り値
名前が入力と一致する PivotTableStyle オブジェクト。
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection;パラメーター
- options
-
Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
setDefault(newDefaultStyle)
親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。
setDefault(newDefaultStyle: PivotTableStyle | string): void;パラメーター
- newDefaultStyle
-
Excel.PivotTableStyle | string
PivotTableStyle オブジェクト(PivotTableStyle オブジェクトの名前)は、新しい既定値にする必要があります。
戻り値
void
注釈
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTableStyleCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableStyleCollectionDataとして型指定) を返します。
toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;戻り値
Office Add-ins