Excel.PivotTable class
Excel のピボットテーブルを表します。 ピボットテーブル オブジェクト モデルの詳細については、「Excel JavaScript API を使用してピボットテーブルを操作する」を参照してください。
- Extends
注釈
[API セット: ExcelApi 1.3]
プロパティ
| allow |
ピボットテーブルが、テーブル内の特定のピボットフィールドに複数のピボットフィルターを適用できるかどうかを指定します。 |
| column |
ピボットテーブルの列ピボット階層。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| data |
ピボットテーブルのデータ ピボット階層。 |
| enable |
ピボットテーブルでデータ本文の値をユーザーが編集できるかどうかを指定します。 |
| filter |
ピボットテーブルのフィルター ピボット階層。 |
| hierarchies | ピボットテーブルのピボット階層。 |
| id | ピボットテーブルの ID。 |
| layout | ピボットテーブルのレイアウトとビジュアル構造を記述する PivotLayout。 |
| name | ピボットテーブルの名前。 |
| refresh |
ブックを開いたときにピボットテーブルを更新するかどうかを指定します。 UI の [読み込み時に更新] 設定に対応します。 |
| row |
ピボットテーブルの行ピボット階層。 |
| use |
並べ替え時にピボットテーブルでカスタム リストを使用するかどうかを指定します。 |
| worksheet | 現在のピボットテーブルを含んでいるワークシート。 |
メソッド
| delete() | ピボットテーブルを削除します。 |
| get |
ピボットテーブルのデータ ソースの文字列表現を返します。 このメソッドは現在、テーブル オブジェクトと範囲オブジェクトの文字列表現をサポートしています。 それ以外の場合は、空の文字列が返されます。 |
| get |
ピボットテーブルのデータ ソースの種類を取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| refresh() | ピボットテーブルを更新します。 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
allowMultipleFiltersPerField
ピボットテーブルが、テーブル内の特定のピボットフィールドに複数のピボットフィルターを適用できるかどうかを指定します。
allowMultipleFiltersPerField: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.12]
columnHierarchies
ピボットテーブルの列ピボット階層。
readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
dataHierarchies
ピボットテーブルのデータ ピボット階層。
readonly dataHierarchies: Excel.DataPivotHierarchyCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
enableDataValueEditing
ピボットテーブルでデータ本文の値をユーザーが編集できるかどうかを指定します。
enableDataValueEditing: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.9]
filterHierarchies
ピボットテーブルのフィルター ピボット階層。
readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
hierarchies
ピボットテーブルのピボット階層。
readonly hierarchies: Excel.PivotHierarchyCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
id
ピボットテーブルの ID。
readonly id: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.5]
layout
ピボットテーブルのレイアウトとビジュアル構造を記述する PivotLayout。
readonly layout: Excel.PivotLayout;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
name
ピボットテーブルの名前。
name: string;
プロパティ値
string
注釈
[API セット: ExcelApi 1.3]
refreshOnOpen
ブックを開いたときにピボットテーブルを更新するかどうかを指定します。 UI の [読み込み時に更新] 設定に対応します。
refreshOnOpen: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.13]
rowHierarchies
ピボットテーブルの行ピボット階層。
readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;
プロパティ値
注釈
[API セット: ExcelApi 1.8]
useCustomSortLists
並べ替え時にピボットテーブルでカスタム リストを使用するかどうかを指定します。
useCustomSortLists: boolean;
プロパティ値
boolean
注釈
[API セット: ExcelApi 1.9]
worksheet
現在のピボットテーブルを含んでいるワークシート。
readonly worksheet: Excel.Worksheet;
プロパティ値
注釈
[API セット: ExcelApi 1.3]
メソッドの詳細
delete()
ピボットテーブルを削除します。
delete(): void;
返品
void
注釈
[API セット: ExcelApi 1.8]
getDataSourceString()
ピボットテーブルのデータ ソースの文字列表現を返します。 このメソッドは現在、テーブル オブジェクトと範囲オブジェクトの文字列表現をサポートしています。 それ以外の場合は、空の文字列が返されます。
getDataSourceString(): OfficeExtension.ClientResult<string>;
返品
OfficeExtension.ClientResult<string>
注釈
[API セット: ExcelApi 1.15]
getDataSourceType()
ピボットテーブルのデータ ソースの種類を取得します。
getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
返品
注釈
[API セット: ExcelApi 1.15]
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Excel.PivotTable;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.PivotTable;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
refresh()
ピボットテーブルを更新します。
refresh(): void;
返品
void
注釈
[API セット: ExcelApi 1.3]
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.PivotTableUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Excel.Interfaces.PivotTableUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Excel.PivotTable): void;
パラメーター
- properties
- Excel.PivotTable
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.PivotTable オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.PivotTableData と型指定) を返します。
toJSON(): Excel.Interfaces.PivotTableData;