ExcelScript.PivotLayout interface

各項目の後に空白行を表示するかどうかを設定します。 これはピボットテーブルのグローバル レベルで設定され、個々の PivotFields に適用されます。 この関数は、ピボットテーブル内のすべてのフィールドの設定をパラメーターの値 display 上書きします。

displayBlankLineAfterEachItem(display: boolean): void;

パラメーター

戻り値

ピボットテーブルの代替テキストの説明。

代替テキストは、ピボットテーブルに含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、視覚障碍や認知障碍のあるユーザーが、テーブルを表示または理解できない場合に役立ちます。 タイトルは、障害のある人に読み取ることができ、コンテンツの説明を聞きたいかどうかを判断するために使用されます。

getAltTextDescription(): string;

戻り値

ピボットテーブルの代替テキスト タイトル。

代替テキストは、ピボットテーブルに含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、視覚障碍や認知障碍のあるユーザーが、テーブルを表示または理解できない場合に役立ちます。 タイトルは、障害のある人に読み取ることができ、コンテンツの説明を聞きたいかどうかを判断するために使用されます。

getAltTextTitle(): string;

戻り値

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

getAutoFormat(): boolean;

戻り値

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

getBodyAndTotalRange(): 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(): Range;

戻り値

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

getDataHierarchy(cell: Range | string): DataPivotHierarchy;

パラメーター

戻り値

fillEmptyCells == true 場合にピボットテーブルの空のセルに自動的に入力されるテキスト。 fillEmptyCellsがfalseに設定されている場合、この値は保持され、この値を設定してもそのプロパティはtrueに設定されないことに注意してください。 既定では、これは空の文字列です。

getEmptyCellText(): string;

戻り値

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

getEnableFieldList(): boolean;

戻り値

ピボットテーブルの空のセルに emptyCellTextを設定するかどうかを指定します。 既定値は falseです。 このプロパティが false に設定されている場合、emptyCellText の値は保持されることに注意してください。

getFillEmptyCells(): boolean;

戻り値

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

getFilterAxisRange(): Range;

戻り値

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

getLayoutType(): PivotLayoutType;

戻り値

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

getPreserveFormatting(): boolean;

戻り値

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

getRange(): Range;

戻り値

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

getRowLabelRange(): Range;

戻り値

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

getShowColumnGrandTotals(): boolean;

戻り値

ピボットテーブルにフィールド ヘッダー (フィールド キャプションとフィルター ドロップダウン) を表示するかどうかを指定します。

getShowFieldHeaders(): boolean;

戻り値

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

getShowRowGrandTotals(): boolean;

戻り値

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

getSubtotalLocation(): SubtotalLocationType;

戻り値

ピボットテーブルのすべてのフィールドに対して "すべての項目ラベルを繰り返す" 設定を設定します。

repeatAllItemLabels(repeatLabels: boolean): void;

パラメーター

戻り値

ピボットテーブルの代替テキストの説明。

代替テキストは、ピボットテーブルに含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、視覚障碍や認知障碍のあるユーザーが、テーブルを表示または理解できない場合に役立ちます。 タイトルは、障害のある人に読み取ることができ、コンテンツの説明を聞きたいかどうかを判断するために使用されます。

setAltTextDescription(altTextDescription: string): void;

パラメーター

戻り値

ピボットテーブルの代替テキスト タイトル。

代替テキストは、ピボットテーブルに含まれる情報の代替テキスト ベースの表現を提供します。 この情報は、視覚障碍や認知障碍のあるユーザーが、テーブルを表示または理解できない場合に役立ちます。 タイトルは、障害のある人に読み取ることができ、コンテンツの説明を聞きたいかどうかを判断するために使用されます。

setAltTextTitle(altTextTitle: string): void;

パラメーター

戻り値

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

setAutoFormat(autoFormat: boolean): void;

パラメーター

戻り値

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

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

パラメーター

戻り値

fillEmptyCells == true 場合にピボットテーブルの空のセルに自動的に入力されるテキスト。 fillEmptyCellsがfalseに設定されている場合、この値は保持され、この値を設定してもそのプロパティはtrueに設定されないことに注意してください。 既定では、これは空の文字列です。

setEmptyCellText(emptyCellText: string): void;

パラメーター

戻り値

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

setEnableFieldList(enableFieldList: boolean): void;

パラメーター

戻り値

ピボットテーブルの空のセルに emptyCellTextを設定するかどうかを指定します。 既定値は falseです。 このプロパティが false に設定されている場合、emptyCellText の値は保持されることに注意してください。

setFillEmptyCells(fillEmptyCells: boolean): void;

パラメーター

戻り値

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

setLayoutType(layoutType: 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: boolean): void;

パラメーター

戻り値

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

setShowColumnGrandTotals(showColumnGrandTotals: boolean): void;

パラメーター

戻り値

ピボットテーブルにフィールド ヘッダー (フィールド キャプションとフィルター ドロップダウン) を表示するかどうかを指定します。

setShowFieldHeaders(showFieldHeaders: boolean): void;

パラメーター

戻り値

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

setShowRowGrandTotals(showRowGrandTotals: boolean): void;

パラメーター

戻り値

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

setSubtotalLocation(subtotalLocation: 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);
}