Excel.PivotTable class

Excel のピボットテーブルを表します。Represents an Excel PivotTable. ピボットテーブルオブジェクトモデルの詳細については、「 Excel JAVASCRIPT API を使用してピボットテーブルを操作する」を参照してください。To learn more about the PivotTable object model, read Work with PivotTables using the Excel JavaScript API.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

Extends

プロパティ

columnHierarchies

ピボットテーブルの列ピボット階層。The Column Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

dataHierarchies

ピボットテーブルのデータ ピボット階層。The Data Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

enableDataValueEditing

ピボットテーブルでユーザーがデータの値を編集できるようにするかどうかを指定します。Specifies whether the PivotTable allows values in the data body to be edited by the user.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

filterHierarchies

ピボットテーブルのフィルター ピボット階層。The Filter Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

hierarchies

ピボットテーブルのピボット階層。The Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

id

ピボットテーブルの ID。Id of the PivotTable. 読み取り専用です。Read-only.

[API セット: excelapi 1.5][ API set: ExcelApi 1.5 ]

layout

ピボットテーブルのレイアウトとビジュアル構造を記述する PivotLayout。The PivotLayout describing the layout and visual structure of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

name

ピボットテーブルの名前。Name of the PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

rowHierarchies

ピボットテーブルの行ピボット階層。The Row Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

useCustomSortLists

ピボット テーブルで並べ替えを実行する際にユーザー設定リストを使用するかどうかを指定します。Specifies whether the PivotTable uses custom lists when sorting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

worksheet

現在のピボットテーブルを含んでいるワークシート。The worksheet containing the current PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

メソッド

delete()

ピボットテーブルを削除します。Deletes the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

refresh()

ピボットテーブルを更新します。Refreshes the PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel PivotTable オブジェクトは API オブジェクトですが、このメソッドtoJSONはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.PivotTableData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTable object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

columnHierarchies

ピボットテーブルの列ピボット階層。The Column Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly columnHierarchies: Excel.RowColumnPivotHierarchyCollection;

プロパティ値

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");       

    // check if the PivotTable already has a column
    const column = pivotTable.columnHierarchies.getItemOrNullObject("Farm");
    column.load("id");
    await context.sync();

    if (column.isNullObject) {
        // ading the farm column to the column hierarchy automatically removes it from the row hierarchy
        pivotTable.columnHierarchies.add(pivotTable.hierarchies.getItem("Farm"));
    } else {
        pivotTable.columnHierarchies.remove(column);
    }

    await context.sync();
});

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

dataHierarchies

ピボットテーブルのデータ ピボット階層。The Data Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly dataHierarchies: Excel.DataPivotHierarchyCollection;

プロパティ値

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold at Farm"));
    pivotTable.dataHierarchies.add(pivotTable.hierarchies.getItem("Crates Sold Wholesale"));

    await context.sync();
});

enableDataValueEditing

ピボットテーブルでユーザーがデータの値を編集できるようにするかどうかを指定します。Specifies whether the PivotTable allows values in the data body to be edited by the user.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

enableDataValueEditing: boolean;

プロパティ値

boolean

filterHierarchies

ピボットテーブルのフィルター ピボット階層。The Filter Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly filterHierarchies: Excel.FilterPivotHierarchyCollection;

プロパティ値

Examples

async function filter(functionType: Excel.AggregationFunction) {
    await Excel.run(async (context) => {
        const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
        const filters = pivotTable.filterHierarchies;
        const filter = filters.getItemOrNullObject("Classification");
        filter.load();
        await context.sync();

        // add the Classification hierarchy to the filter, if it's not already there
        if (filter.isNullObject) {
            filters.add(pivotTable.hierarchies.getItem("Classification"));
            await context.sync();
        }
    });
}

hierarchies

ピボットテーブルのピボット階層。The Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly hierarchies: Excel.PivotHierarchyCollection;

プロパティ値

id

ピボットテーブルの ID。Id of the PivotTable. 読み取り専用です。Read-only.

[API セット: excelapi 1.5][ API set: ExcelApi 1.5 ]

readonly id: string;

プロパティ値

string

layout

ピボットテーブルのレイアウトとビジュアル構造を記述する PivotLayout。The PivotLayout describing the layout and visual structure of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly layout: Excel.PivotLayout;

プロパティ値

Examples

await Excel.run(async (context) => {
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");
    pivotTable.layout.load("layoutType");
    await context.sync();

    // cycle between the three layout types
    if (pivotTable.layout.layoutType === "Compact") {
        pivotTable.layout.layoutType = "Outline";
    } else if (pivotTable.layout.layoutType === "Outline") {
        pivotTable.layout.layoutType = "Tabular";
    } else {
        pivotTable.layout.layoutType = "Compact";
    }
    await context.sync();
    console.log("Pivot layout is now " + pivotTable.layout.layoutType);
});

name

ピボットテーブルの名前。Name of the PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

name: string;

プロパティ値

string

rowHierarchies

ピボットテーブルの行ピボット階層。The Row Pivot Hierarchies of the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly rowHierarchies: Excel.RowColumnPivotHierarchyCollection;

プロパティ値

useCustomSortLists

ピボット テーブルで並べ替えを実行する際にユーザー設定リストを使用するかどうかを指定します。Specifies whether the PivotTable uses custom lists when sorting.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

useCustomSortLists: boolean;

プロパティ値

boolean

worksheet

現在のピボットテーブルを含んでいるワークシート。The worksheet containing the current PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

readonly worksheet: Excel.Worksheet;

プロパティ値

メソッドの詳細

delete()

ピボットテーブルを削除します。Deletes the PivotTable.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

delete(): void;

戻り値

void

Examples

await Excel.run(async (context) => {
    context.workbook.worksheets.getItem("Pivot").pivotTables.getItem("Farm Sales").delete();

    await context.sync();
});

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.PivotTableLoadOptions): Excel.PivotTable;

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.PivotTable-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.PivotTable - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.PivotTable-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.PivotTable - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTable-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotTable - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

refresh()

ピボットテーブルを更新します。Refreshes the PivotTable.

[API セット: excelapi 1.3][ API set: ExcelApi 1.3 ]

refresh(): void;

戻り値

void

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.PivotTableUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.PivotTable): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.PivotTable): void;

パラメーター

properties
Excel.PivotTable

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の Excel PivotTable オブジェクトは API オブジェクトですが、このメソッドtoJSONはプレーンな JavaScript オブジェクト (として型指定されます) を返します。Excel.Interfaces.PivotTableData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotTable object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotTableData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PivotTableData;

戻り値