ExcelScript.DataPivotHierarchy interface

パッケージ:

ExcelScript

Excel DataPivotHierarchy を表します。

注釈

例

/**
 *  This sample sorts the rows of a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get an existing PivotTable.
  const pivotTable = workbook.getPivotTable("Farm Sales");

  // Get the data hierarchy to use as the basis of the sort.
  const valueFieldToSortOn: ExcelScript.DataPivotHierarchy = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort: ExcelScript.RowColumnPivotHierarchy = pivotTable.getRowHierarchy("Farm");

  // Sort the "Farm" row's only field by the values in "Sum of Crates Sold Wholesale".
  rowToSort.getFields()[0].sortByValues(ExcelScript.SortBy.descending, valueFieldToSortOn);
}

メソッド

getField()	DataPivotHierarchy に関連付けられているピボット フィールドを返します。
getId()	DataPivotHierarchy の ID。
getName()	DataPivotHierarchy の名前。
getNumberFormat()	DataPivotHierarchy の数値形式。
getPosition()	DataPivotHierarchy の位置。
getShowAs()	データを特定の集計計算として表示するかどうかを指定します。
getSummarizeBy()	DataPivotHierarchy のすべての項目を表示するかどうかを指定します。
setName(name)	DataPivotHierarchy の名前。
setNumberFormat(numberFormat)	DataPivotHierarchy の数値形式。
setPosition(position)	DataPivotHierarchy の位置。
setShowAs(showAs)	データを特定の集計計算として表示するかどうかを指定します。
setSummarizeBy(summarizeBy)	DataPivotHierarchy のすべての項目を表示するかどうかを指定します。
setToDefault()	DataPivotHierarchy を既定値にリセットします。

メソッドの詳細

getField()

DataPivotHierarchy に関連付けられているピボット フィールドを返します。

getField(): PivotField;

戻り値

ExcelScript.PivotField

getId()

DataPivotHierarchy の ID。

getId(): string;

戻り値

string

getName()

DataPivotHierarchy の名前。

getName(): string;

戻り値

string

getNumberFormat()

DataPivotHierarchy の数値形式。

getNumberFormat(): string;

戻り値

string

getPosition()

DataPivotHierarchy の位置。

getPosition(): number;

戻り値

number

getShowAs()

データを特定の集計計算として表示するかどうかを指定します。

getShowAs(): ShowAsRule;

戻り値

ExcelScript.ShowAsRule

getSummarizeBy()

DataPivotHierarchy のすべての項目を表示するかどうかを指定します。

getSummarizeBy(): AggregationFunction;

戻り値

ExcelScript.AggregationFunction

setName(name)

DataPivotHierarchy の名前。

setName(name: string): void;

パラメーター

name

string

戻り値

void

setNumberFormat(numberFormat)

DataPivotHierarchy の数値形式。

setNumberFormat(numberFormat: string): void;

パラメーター

numberFormat

string

戻り値

void

setPosition(position)

DataPivotHierarchy の位置。

setPosition(position: number): void;

パラメーター

position

number

戻り値

void

setShowAs(showAs)

データを特定の集計計算として表示するかどうかを指定します。

setShowAs(showAs: ShowAsRule): void;

パラメーター

showAs

ExcelScript.ShowAsRule

戻り値

void

例

/**
 * The script changes the display for "Crates Sold at Farm".
 * It shows the percentage of the grand total, 
 * instead of the default sum.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Get the data hierarchy "Sum of Crates Sold at Farm".
  const farmSales = farmPivot.getDataHierarchy("Sum of Crates Sold at Farm");

  // Show the data as a percentage of the grand total.
  farmSales.setShowAs({
    calculation: ExcelScript.ShowAsCalculation.percentOfGrandTotal
  });
}

setSummarizeBy(summarizeBy)

DataPivotHierarchy のすべての項目を表示するかどうかを指定します。

setSummarizeBy(summarizeBy: AggregationFunction): void;

パラメーター

summarizeBy

ExcelScript.AggregationFunction

戻り値

void

例

/**
 * This script changes how the data in a PivotTable is aggregated.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable in the workbook.
  const pivotTable = workbook.getPivotTables()[0];
  
  // Set the first data hierarchy to summarize with an average value, instead of a sum.
  const dataHierarchy = pivotTable.getDataHierarchies()[0];
  dataHierarchy.setSummarizeBy(ExcelScript.AggregationFunction.average);
}

setToDefault()

DataPivotHierarchy を既定値にリセットします。

setToDefault(): void;

戻り値

void