ExcelScript.PivotLayout interface

パッケージ:

ExcelScript

ピボットテーブルのビジュアル レイアウトを表します。

メソッド

getAutoFormat()	更新時またはフィールドの移動時に書式を自動的に設定するかどうかを指定します。
getBodyAndTotalRange()	ピボットテーブルのデータ値が存在する範囲を返します。
getColumnLabelRange()	ピボットテーブルの列ラベルが存在する範囲を返します。
getDataHierarchy(cell)	PivotTable 内で指定された範囲の値を計算するために使用される DataHierarchy を取得します。
getEnableFieldList()	フィールド リストを UI に表示できるかどうかを指定します。
getFilterAxisRange()	ピボットテーブルのフィルター エリアの範囲を返します。
getLayoutType()	このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。 フィールドによって状態が異なる場合は null 値になります。
getPreserveFormatting()	ピボット、並べ替え、ページ フィールド 項目の変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。
getRange()	フィルター エリアを除く、ピボットテーブルが存在する範囲を返します。
getRowLabelRange()	ピボットテーブルの行ラベルが存在する範囲を返します。
getShowColumnGrandTotals()	ピボットテーブル レポートに列の総計を表示するかどうかを指定します。
getShowRowGrandTotals()	ピボットテーブル レポートに行の総計を表示するかどうかを指定します。
getSubtotalLocation()	このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。 フィールドの状態が異なる場合、これは nullされます。
setAutoFormat(autoFormat)	更新時またはフィールドの移動時に書式を自動的に設定するかどうかを指定します。
setAutoSortOnCell(cell, sortBy)	必要なすべての条件とコンテキストを自動的に選択するため、指定したセルを使用して自動的に並べ替えを実行するようピボットテーブルを設定します。 これは、UI から自動並べ替えを適用するのと同じ動作です。
setEnableFieldList(enableFieldList)	フィールド リストを UI に表示できるかどうかを指定します。
setLayoutType(layoutType)	このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。 フィールドによって状態が異なる場合は null 値になります。
setPreserveFormatting(preserveFormatting)	ピボット、並べ替え、ページ フィールド 項目の変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。
setShowColumnGrandTotals(showColumnGrandTotals)	ピボットテーブル レポートに列の総計を表示するかどうかを指定します。
setShowRowGrandTotals(showRowGrandTotals)	ピボットテーブル レポートに行の総計を表示するかどうかを指定します。
setSubtotalLocation(subtotalLocation)	このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。 フィールドの状態が異なる場合、これは nullされます。

メソッドの詳細

getAutoFormat()

更新時またはフィールドの移動時に書式を自動的に設定するかどうかを指定します。

getAutoFormat(): boolean;

戻り値

boolean

getBodyAndTotalRange()

ピボットテーブルのデータ値が存在する範囲を返します。

getBodyAndTotalRange(): Range;

戻り値

ExcelScript.Range

例

/**
 * This sample finds the first PivotTable in the workbook and logs the values in the "Grand Total" cells.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  let pivotTable = workbook.getPivotTables()[0];

  // Get the names of each data column in the PivotTable.
  let pivotColumnLabelRange = pivotTable.getLayout().getColumnLabelRange();

  // Get the range displaying the pivoted data.
  let pivotDataRange = pivotTable.getLayout().getBodyAndTotalRange();

  // Get the range with the "grand totals" for the PivotTable columns.
  let grandTotalRange = pivotDataRange.getLastRow();

  // Print each of the "Grand Totals" to the console.
  grandTotalRange.getValues()[0].forEach((column, columnIndex) => {
    console.log(`Grand total of ${pivotColumnLabelRange.getValues()[0][columnIndex]}: ${grandTotalRange.getValues()[0][columnIndex]}`);
    // Example log: "Grand total of Sum of Crates Sold Wholesale: 11000"
  });
}

getColumnLabelRange()

ピボットテーブルの列ラベルが存在する範囲を返します。

getColumnLabelRange(): Range;

戻り値

ExcelScript.Range

getDataHierarchy(cell)

PivotTable 内で指定された範囲の値を計算するために使用される DataHierarchy を取得します。

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

パラメーター

cell

ExcelScript.Range | string

ピボットテーブル データ本文内の 1 つのセル。

戻り値

ExcelScript.DataPivotHierarchy

getEnableFieldList()

フィールド リストを UI に表示できるかどうかを指定します。

getEnableFieldList(): boolean;

戻り値

boolean

getFilterAxisRange()

ピボットテーブルのフィルター エリアの範囲を返します。

getFilterAxisRange(): Range;

戻り値

ExcelScript.Range

getLayoutType()

このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。 フィールドによって状態が異なる場合は null 値になります。

getLayoutType(): PivotLayoutType;

戻り値

ExcelScript.PivotLayoutType

getPreserveFormatting()

ピボット、並べ替え、ページ フィールド 項目の変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。

getPreserveFormatting(): boolean;

戻り値

boolean

getRange()

フィルター エリアを除く、ピボットテーブルが存在する範囲を返します。

getRange(): Range;

戻り値

ExcelScript.Range

getRowLabelRange()

ピボットテーブルの行ラベルが存在する範囲を返します。

getRowLabelRange(): Range;

戻り値

ExcelScript.Range

getShowColumnGrandTotals()

ピボットテーブル レポートに列の総計を表示するかどうかを指定します。

getShowColumnGrandTotals(): boolean;

戻り値

boolean

getShowRowGrandTotals()

ピボットテーブル レポートに行の総計を表示するかどうかを指定します。

getShowRowGrandTotals(): boolean;

戻り値

boolean

getSubtotalLocation()

このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。 フィールドの状態が異なる場合、これは nullされます。

getSubtotalLocation(): SubtotalLocationType;

戻り値

ExcelScript.SubtotalLocationType

setAutoFormat(autoFormat)

更新時またはフィールドの移動時に書式を自動的に設定するかどうかを指定します。

setAutoFormat(autoFormat: boolean): void;

パラメーター

autoFormat

boolean

戻り値

void

setAutoSortOnCell(cell, sortBy)

必要なすべての条件とコンテキストを自動的に選択するため、指定したセルを使用して自動的に並べ替えを実行するようピボットテーブルを設定します。 これは、UI から自動並べ替えを適用するのと同じ動作です。

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

パラメーター

cell

ExcelScript.Range | string

使用する 1 つのセルは、自動ソートを適用するための条件を取得します。

sortBy

ExcelScript.SortBy

並べ替えの方向。

戻り値

void

setEnableFieldList(enableFieldList)

フィールド リストを UI に表示できるかどうかを指定します。

setEnableFieldList(enableFieldList: boolean): void;

パラメーター

enableFieldList

boolean

戻り値

void

setLayoutType(layoutType)

このプロパティは、ピボットテーブルのすべてのフィールドの PivotLayoutType を示します。 フィールドによって状態が異なる場合は null 値になります。

setLayoutType(layoutType: PivotLayoutType): void;

パラメーター

layoutType

ExcelScript.PivotLayoutType

戻り値

void

例

/**
 * This script sets the layout of the "Farms Sales" PivotTable to the "tabular"
 * setting. This places the fields from the Rows area in separate columns.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Set the layout type to "tabular".
  layout.setLayoutType(ExcelScript.PivotLayoutType.tabular);
}

setPreserveFormatting(preserveFormatting)

ピボット、並べ替え、ページ フィールド 項目の変更などの操作によってレポートを更新または再計算するときに、書式設定を保持するかどうかを指定します。

setPreserveFormatting(preserveFormatting: boolean): void;

パラメーター

preserveFormatting

boolean

戻り値

void

setShowColumnGrandTotals(showColumnGrandTotals)

ピボットテーブル レポートに列の総計を表示するかどうかを指定します。

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

パラメーター

showColumnGrandTotals

boolean

戻り値

void

setShowRowGrandTotals(showRowGrandTotals)

ピボットテーブル レポートに行の総計を表示するかどうかを指定します。

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

パラメーター

showRowGrandTotals

boolean

戻り値

void

setSubtotalLocation(subtotalLocation)

このプロパティは、ピボットテーブルのすべてのフィールドの SubtotalLocationType を示します。 フィールドの状態が異なる場合、これは nullされます。

setSubtotalLocation(subtotalLocation: SubtotalLocationType): void;

パラメーター

subtotalLocation

ExcelScript.SubtotalLocationType

戻り値

void

例

/**
 * This script displays group subtotals of the "Farms Sales" PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the PivotLayout object.
  const layout = pivot.getLayout();

  // Show all the subtotals at the bottom of each group.
  layout.setSubtotalLocation(ExcelScript.SubtotalLocationType.atBottom);
}