Excel.PivotLayout class

ピボットテーブルの視覚的なレイアウトを表します。Represents the visual layout of the PivotTable.

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

Extends

プロパティ

autoFormat

更新時またはフィールドの移動時に書式を自動的に書式設定するかどうかを指定します。Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved

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

context

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

enableFieldList

UI にフィールドリストを表示できるかどうかを指定します。Specifies whether the field list can be shown in the UI.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

layoutType

このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。This property indicates the PivotLayoutType of all fields on the PivotTable. フィールドによって状態が異なる場合は null 値になります。If fields have different states, this will be null.

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

preserveFormatting

ピボット、並べ替え、ページフィールドアイテムの変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。Specifies whether formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.

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

showColumnGrandTotals

ピボットテーブルレポートに列の総計を表示するかどうかを指定します。Specifies whether the PivotTable report shows grand totals for columns.

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

showRowGrandTotals

ピボットテーブルレポートで行の総計を表示するかどうかを指定します。Specifies whether the PivotTable report shows grand totals for rows.

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

subtotalLocation

このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。This property indicates the SubtotalLocationType of all fields on the PivotTable. フィールドによって状態が異なる場合は null 値になります。If fields have different states, this will be null.

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

メソッド

getCell(dataHierarchy, rowItems, columnItems)

データ階層と、それぞれの階層の行および列の項目に基づいて、ピボットテーブル内の一意のセルを取得します。Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies. 返されるセルは、指定した階層のデータを含む、指定された行と列の交差部分です。The returned cell is the intersection of the given row and column that contains the data from the given hierarchy. このメソッドは、特定のセルの getPivotItems および getDataHierarchy の呼び出しを逆にしたものです。This method is the inverse of calling getPivotItems and getDataHierarchy on a particular cell.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getColumnLabelRange()

ピボットテーブルの列ラベルが存在する範囲を返します。Returns the range where the PivotTable's column labels reside.

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

getDataBodyRange()

ピボットテーブルのデータ値が存在する範囲を返します。Returns the range where the PivotTable's data values reside.

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

getDataHierarchy(cell)

PivotTable 内で指定された範囲の値を計算するために使用される DataHierarchy を取得します。Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.

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

getFilterAxisRange()

ピボットテーブルのフィルター エリアの範囲を返します。Returns the range of the PivotTable's filter area.

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

getPivotItems(axis, cell)

PivotTable 内で指定された範囲の値を構成する PivotItems を軸から取得します。Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.

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

getPivotItems(axisString, cell)

PivotTable 内で指定された範囲の値を構成する PivotItems を軸から取得します。Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.

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

getRange()

フィルター エリアを除く、ピボットテーブルが存在する範囲を返します。Returns the range the PivotTable exists on, excluding the filter area.

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

getRowLabelRange()

ピボットテーブルの行ラベルが存在する範囲を返します。Returns the range where the PivotTable's row labels reside.

[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.

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.

setAutoSortOnCell(cell, sortBy)

指定したセルを使用して自動的に並べ替え、必要なすべての条件とコンテキストを自動的に選択するようにピボットテーブルを設定します。Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. これは、UI から自動並べ替えを適用するのと同じように動作します。This behaves identically to applying an autosort from the UI.

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

setAutoSortOnCell(cell, sortByString)

指定したセルを使用して自動的に並べ替え、必要なすべての条件とコンテキストを自動的に選択するようにピボットテーブルを設定します。Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. これは、UI から自動並べ替えを適用するのと同じように動作します。This behaves identically to applying an autosort from the UI.

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

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オブジェクトのメソッドを呼び出します。元の PivotLayout オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.PivotLayoutData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotLayout object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotLayoutData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

autoFormat

更新時またはフィールドの移動時に書式を自動的に書式設定するかどうかを指定します。Specifies whether formatting will be automatically formatted when it’s refreshed or when fields are moved

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

autoFormat: boolean;

プロパティ値

boolean

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

enableFieldList

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

UI にフィールドリストを表示できるかどうかを指定します。Specifies whether the field list can be shown in the UI.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

enableFieldList: boolean;

プロパティ値

boolean

layoutType

このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。This property indicates the PivotLayoutType of all fields on the PivotTable. フィールドによって状態が異なる場合は null 値になります。If fields have different states, this will be null.

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

layoutType: Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline";

プロパティ値

Excel.PivotLayoutType | "Compact" | "Tabular" | "Outline"

preserveFormatting

ピボット、並べ替え、ページフィールドアイテムの変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。Specifies whether formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.

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

preserveFormatting: boolean;

プロパティ値

boolean

showColumnGrandTotals

ピボットテーブルレポートに列の総計を表示するかどうかを指定します。Specifies whether the PivotTable report shows grand totals for columns.

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

showColumnGrandTotals: boolean;

プロパティ値

boolean

showRowGrandTotals

ピボットテーブルレポートで行の総計を表示するかどうかを指定します。Specifies whether the PivotTable report shows grand totals for rows.

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

showRowGrandTotals: boolean;

プロパティ値

boolean

subtotalLocation

このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。This property indicates the SubtotalLocationType of all fields on the PivotTable. フィールドによって状態が異なる場合は null 値になります。If fields have different states, this will be null.

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

subtotalLocation: Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off";

プロパティ値

Excel.SubtotalLocationType | "AtTop" | "AtBottom" | "Off"

メソッドの詳細

getCell(dataHierarchy, rowItems, columnItems)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

データ階層と、それぞれの階層の行および列の項目に基づいて、ピボットテーブル内の一意のセルを取得します。Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies. 返されるセルは、指定した階層のデータを含む、指定された行と列の交差部分です。The returned cell is the intersection of the given row and column that contains the data from the given hierarchy. このメソッドは、特定のセルの getPivotItems および getDataHierarchy の呼び出しを逆にしたものです。This method is the inverse of calling getPivotItems and getDataHierarchy on a particular cell.

[API セット: EXCELAPI BETA (プレビューのみ)][ API set: ExcelApi BETA (PREVIEW ONLY) ]

getCell(dataHierarchy: DataPivotHierarchy | string, rowItems: Array<PivotItem | string>, columnItems: Array<PivotItem | string>): Excel.Range;

パラメーター

dataHierarchy
DataPivotHierarchy | string

検索するデータ項目を提供する dataHierarchy。The dataHierarchy that provides the data item to find.

rowItems
Array<PivotItem | string>

検索する値を構成する行軸からの PivotItems。The PivotItems from the row axis that make up the value to find.

columnItems
Array<PivotItem | string>

検索する値を設定する列軸からの PivotItems。The PivotItems from the column axis that make up the value to find.

戻り値

指定された値を含む単一のセルを指定する範囲。A range specifying a single cell that contains the value specified.

getColumnLabelRange()

ピボットテーブルの列ラベルが存在する範囲を返します。Returns the range where the PivotTable's column labels reside.

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

getColumnLabelRange(): Excel.Range;

戻り値

getDataBodyRange()

ピボットテーブルのデータ値が存在する範囲を返します。Returns the range where the PivotTable's data values reside.

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

getDataBodyRange(): Excel.Range;

戻り値

Examples

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

    // the layout controls the ranges used by the PivotTable
    const range = pivotTable.layout.getDataBodyRange();

    // get all the data hierarchy totals
    const grandTotalRange = range.getLastRow();
    grandTotalRange.load("address");
    await context.sync();
    
    // use the wholesale and farm sale totals to make a final sum
    const masterTotalRange = context.workbook.worksheets.getActiveWorksheet().getRange("B27:C27");
    masterTotalRange.formulas = [["All Crates", "=SUM(" + grandTotalRange.address + ")"]];
    await context.sync();
});

getDataHierarchy(cell)

PivotTable 内で指定された範囲の値を計算するために使用される DataHierarchy を取得します。Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.

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

getDataHierarchy(cell: Range | string): Excel.DataPivotHierarchy;

パラメーター

cell
Range | string

ピボットテーブルのデータ本文内の1つのセル。A single cell within the PivotTable data body.

戻り値

指定したセルの値を計算するために使用される DataPivotHierarchy オブジェクト。The DataPivotHierarchy object used to calculate the value in the specified cell.

getFilterAxisRange()

ピボットテーブルのフィルター エリアの範囲を返します。Returns the range of the PivotTable's filter area.

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

getFilterAxisRange(): Excel.Range;

戻り値

getPivotItems(axis, cell)

PivotTable 内で指定された範囲の値を構成する PivotItems を軸から取得します。Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.

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

getPivotItems(axis: Excel.PivotAxis, cell: Range | string): OfficeExtension.ClientResult<Excel.PivotItem[]>;

パラメーター

axis
Excel.PivotAxis

PivotItems の取得元の軸。The axis from which to get the PivotItems. "Row" または "column" である必要があります。Must be either "row" or "column."

cell
Range | string

ピボットテーブルのデータ本文内の1つのセル。A single cell within the PivotTable's data body.

戻り値

OfficeExtension.ClientResult<Excel.PivotItem[]>

指定された行の値を計算するために使用される PivotItems のコレクション。A collection of PivotItems that are used to calculate the values in the specified row.

getPivotItems(axisString, cell)

PivotTable 内で指定された範囲の値を構成する PivotItems を軸から取得します。Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.

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

getPivotItems(axisString: "Unknown" | "Row" | "Column" | "Data" | "Filter", cell: Range | string): OfficeExtension.ClientResult<Excel.PivotItem[]>;

パラメーター

axisString
"Unknown" | "Row" | "Column" | "Data" | "Filter"

PivotItems の取得元の軸。The axis from which to get the PivotItems. "Row" または "column" である必要があります。Must be either "row" or "column."

cell
Range | string

ピボットテーブルのデータ本文内の1つのセル。A single cell within the PivotTable's data body.

戻り値

OfficeExtension.ClientResult<Excel.PivotItem[]>

指定された行の値を計算するために使用される PivotItems のコレクション。A collection of PivotItems that are used to calculate the values in the specified row.

getRange()

フィルター エリアを除く、ピボットテーブルが存在する範囲を返します。Returns the range the PivotTable exists on, excluding the filter area.

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

getRange(): Excel.Range;

戻り値

getRowLabelRange()

ピボットテーブルの行ラベルが存在する範囲を返します。Returns the range where the PivotTable's row labels reside.

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

getRowLabelRange(): Excel.Range;

戻り値

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.PivotLayoutLoadOptions): Excel.PivotLayout;

パラメーター

戻り値

注釈

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

load(option?: string | string[]): Excel.PivotLayout-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.PivotLayout - 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.PivotLayout-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.PivotLayout - 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.PivotLayout-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.PivotLayout - 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.PivotLayout;

パラメーター

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.PivotLayout;

パラメーター

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.

戻り値

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.PivotLayoutUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties
Interfaces.PivotLayoutUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 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.PivotLayout): void

set(properties)

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

set(properties: Excel.PivotLayout): void;

パラメーター

properties
Excel.PivotLayout

戻り値

void

setAutoSortOnCell(cell, sortBy)

指定したセルを使用して自動的に並べ替え、必要なすべての条件とコンテキストを自動的に選択するようにピボットテーブルを設定します。Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. これは、UI から自動並べ替えを適用するのと同じように動作します。This behaves identically to applying an autosort from the UI.

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

setAutoSortOnCell(cell: Range | string, sortBy: Excel.SortBy): void;

パラメーター

cell
Range | string

1つのセルを使用して、自動並べ替えを適用する抽出条件を取得します。A single cell to use get the criteria from for applying the autosort.

sortBy
Excel.SortBy

並べ替えの方向を示します。The direction of the sort.

戻り値

void

setAutoSortOnCell(cell, sortByString)

指定したセルを使用して自動的に並べ替え、必要なすべての条件とコンテキストを自動的に選択するようにピボットテーブルを設定します。Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context. これは、UI から自動並べ替えを適用するのと同じように動作します。This behaves identically to applying an autosort from the UI.

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

setAutoSortOnCell(cell: Range | string, sortByString: "Ascending" | "Descending"): void;

パラメーター

cell
Range | string

1つのセルを使用して、自動並べ替えを適用する抽出条件を取得します。A single cell to use get the criteria from for applying the autosort.

sortByString
"Ascending" | "Descending"

並べ替えの方向を示します。The direction of the sort.

戻り値

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オブジェクトのメソッドを呼び出します。元の PivotLayout オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.PivotLayoutData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PivotLayout object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PivotLayoutData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PivotLayoutData;

戻り値