ExcelScript.PivotField interface

フィールドの現在の PivotFilter を 1 つ以上設定し、フィールドに適用します。 指定されたフィルターが無効であるか、適用できない場合は、例外がスローされます。

applyFilter(filter: PivotFilters): void;

パラメーター

戻り値

例

/**
 * This script applies a PivotValueFilter to the first row hierarchy in the PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable on the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let pivotTable = sheet.getPivotTables()[0];

  // Get the first row hierarchy to use as the field which gets filtered.
  let rowHierarchy = pivotTable.getRowHierarchies()[0];

  // Get the first data hierarchy to use as the values for filtering the rows.
  let dataHierarchy = pivotTable.getDataHierarchies()[0];

  // Create a filter that excludes values greater than 500.
  let filter: ExcelScript.PivotValueFilter = {
    condition: ExcelScript.ValueFilterCondition.greaterThan,
    comparator: 500,
    value: dataHierarchy.getName()
  };

  // Apply the filter.
  rowHierarchy.getPivotField(rowHierarchy.getName()).applyFilter({
    valueFilter: filter
  });
}

すべてのフィールドのフィルターからすべての条件をクリアします。 これにより、フィールドのアクティブなフィルター処理が削除されます。

clearAllFilters(): void;

戻り値

指定された型のフィールドのフィルターから既存のすべての条件をクリアします (現在適用されている場合)。

clearFilter(filterType: PivotFilterType): void;

パラメーター

戻り値

例

/**
 * This script gets the "Type" field from the "Farms Sales" PivotTable 
 * and clears the value filter from it.
 */ 
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Sales".
  const pivot = workbook.getPivotTable("Farm Sales");

  // Get the "Type" field.
  const typeField = pivot.getHierarchy("Type").getPivotField("Type");

  // Clear the value filter (if there is one) from the field.
  typeField.clearFilter(ExcelScript.PivotFilterType.value);
}

フィールドに現在適用されているすべてのフィルターを取得します。

getFilters(): PivotFilters;

戻り値

PivotField の ID。

getId(): string;

戻り値

PivotField に関連付けられている PivotItems を返します。

getItems(): PivotItem[];

戻り値

PivotField の名前。

getName(): string;

戻り値

名前で PivotItem を取得します。 PivotItem が存在しない場合、このメソッドは undefinedを返します。

getPivotItem(name: string): PivotItem | undefined;

パラメーター

戻り値

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

getShowAllItems(): boolean;

戻り値

PivotField の小計。

getSubtotals(): Subtotals;

戻り値

フィールドに適用されたフィルターがあるかどうかを確認します。

isFiltered(filterType?: PivotFilterType): boolean;

パラメーター

戻り値

PivotField の名前。

setName(name: string): void;

パラメーター

戻り値

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

setShowAllItems(showAllItems: boolean): void;

パラメーター

戻り値

PivotField の小計。

setSubtotals(subtotals: Subtotals): void;

パラメーター

戻り値

PivotField を並べ替えます。 DataPivotHierarchy を指定すると、そのピボット階層に基づいて並べ替えが適用されます。指定しない場合、ピボット フィールド自体が並べ替えの基準になります。

sortByLabels(sortBy: SortBy): void;

パラメーター

戻り値

与えられた範囲で、指定された値に基づいて PivotField を並べ替えます。 スコープは、同じ DataPivotHierarchy から複数の値がある場合に並べ替えに使用する特定の値を定義します。

sortByValues(
            sortBy: SortBy,
            valuesHierarchy: DataPivotHierarchy,
            pivotItemScope?: Array<PivotItem | string>
        ): void;

パラメーター

戻り値

例

/**
 * 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 = pivotTable.getDataHierarchy("Sum of Crates Sold Wholesale");

  // Get the row to sort.
  const rowToSort = 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);
}