Excel.PivotTableStyleCollection class
ピボットテーブル スタイルのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| add(name, make |
指定した名前の空白 |
| get |
コレクションに含まれる PivotTableStyle の数を取得します。 |
| get |
親オブジェクトのスコープの既定のピボットテーブル スタイルを取得します。 |
| get |
名前で を |
| get |
名前で を |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set |
親オブジェクトのスコープで使用する既定のピボットテーブル スタイルを設定します。 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
プロパティの詳細
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が存在しない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *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 オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元 Excel.PivotTableStyleCollection のオブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.PivotTableStyleCollectionData型指定) を返します。
toJSON(): Excel.Interfaces.PivotTableStyleCollectionData;戻り値
Office Add-ins
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示