ExcelScript.PivotField interface

Пакет:

ExcelScript

Представляет сводное поле Excel.

Методика

applyFilter(filter)	Задает один или несколько текущих PivotFilters поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, возникает исключение.
clearAllFilters()	Очищает все критерии из всех фильтров поля. При этом будут удалены все активные фильтры по полю.
clearFilter(filterType)	Очищает все существующие критерии из фильтра поля заданного типа (если он применяется в данный момент).
getFilters()	Возвращает все фильтры, применяемые в настоящее время к полю.
getId()	Идентификатор сводного поля.
getItems()	Возвращает PivotItems, связанные со сводным полем.
getName()	Имя сводного поля.
getPivotItem(name)	Возвращает PivotItem по имени. Если PivotItem не существует, этот метод возвращает undefined.
getShowAllItems()	Определяет, следует ли отображать все элементы сводного поля.
getSubtotals()	Промежуточные итоги сводного поля.
isFiltered(filterType)	Проверяет наличие примененных фильтров к полю.
setName(name)	Имя сводного поля.
setShowAllItems(showAllItems)	Определяет, следует ли отображать все элементы сводного поля.
setSubtotals(subtotals)	Промежуточные итоги сводного поля.
sortByLabels(sortBy)	Сортирует сводное поле. Если указан параметр DataPivotHierarchy, то сортировка будет применяться на его основе, в ином случае сортировка будет основана на самом сводном поле.
sortByValues(sortBy, valuesHierarchy, pivotItemScope)	Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy.

Подробнее о методе

applyFilter(filter)

Задает один или несколько текущих PivotFilters поля и применяет их к полю. Если предоставленные фильтры недопустимы или не могут быть применены, возникает исключение.

applyFilter(filter: PivotFilters): void;

Параметры

filter

ExcelScript.PivotFilters

Настроенный определенный PivotFilter или интерфейс 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()

Очищает все критерии из всех фильтров поля. При этом будут удалены все активные фильтры по полю.

clearAllFilters(): void;

Возвращает

void

clearFilter(filterType)

Очищает все существующие критерии из фильтра поля заданного типа (если он применяется в данный момент).

clearFilter(filterType: PivotFilterType): void;

Параметры

filterType

ExcelScript.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()

Возвращает все фильтры, применяемые в настоящее время к полю.

getFilters(): PivotFilters;

Возвращает

ExcelScript.PivotFilters

getId()

Идентификатор сводного поля.

getId(): string;

Возвращает

string

getItems()

Возвращает PivotItems, связанные со сводным полем.

getItems(): PivotItem[];

Возвращает

ExcelScript.PivotItem[]

getName()

Имя сводного поля.

getName(): string;

Возвращает

string

getPivotItem(name)

Возвращает PivotItem по имени. Если PivotItem не существует, этот метод возвращает undefined.

getPivotItem(name: string): PivotItem | undefined;

Параметры

name

string

Имя извлекаемого PivotItem.

Возвращает

ExcelScript.PivotItem | undefined

getShowAllItems()

Определяет, следует ли отображать все элементы сводного поля.

getShowAllItems(): boolean;

Возвращает

boolean

getSubtotals()

Промежуточные итоги сводного поля.

getSubtotals(): Subtotals;

Возвращает

ExcelScript.Subtotals

isFiltered(filterType)

Проверяет наличие примененных фильтров к полю.

isFiltered(filterType?: PivotFilterType): boolean;

Параметры

filterType

ExcelScript.PivotFilterType

Тип фильтра для проверка. Если тип не указан, этот метод будет проверка, если применен какой-либо фильтр.

Возвращает

boolean

setName(name)

Имя сводного поля.

setName(name: string): void;

Параметры

name

string

Возвращает

void

setShowAllItems(showAllItems)

Определяет, следует ли отображать все элементы сводного поля.

setShowAllItems(showAllItems: boolean): void;

Параметры

showAllItems

boolean

Возвращает

void

setSubtotals(subtotals)

Промежуточные итоги сводного поля.

setSubtotals(subtotals: Subtotals): void;

Параметры

subtotals

ExcelScript.Subtotals

Возвращает

void

sortByLabels(sortBy)

Сортирует сводное поле. Если указан параметр DataPivotHierarchy, то сортировка будет применяться на его основе, в ином случае сортировка будет основана на самом сводном поле.

sortByLabels(sortBy: SortBy): void;

Параметры

sortBy

ExcelScript.SortBy

Указывает, выполняется ли сортировка по возрастанию или убыванию.

Возвращает

void

sortByValues(sortBy, valuesHierarchy, pivotItemScope)

Сортирует сводную таблицу по указанным значениям в определенной области. Область определяет, какие конкретные значения будут использоваться для сортировки при наличии нескольких значений из одной и той же DataPivotHierarchy.

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

Параметры

sortBy

ExcelScript.SortBy

Указывает, выполняется ли сортировка по возрастанию или убыванию.

valuesHierarchy

ExcelScript.DataPivotHierarchy

Указывает иерархию значений на оси данных, которая будет использоваться для сортировки.

pivotItemScope

Array<ExcelScript.PivotItem | string>

Элементы, которые должны использоваться для область сортировки. Это будут элементы, составляющие строку или столбец, по которым требуется отсортировать. Если вместо PivotItem используется строка, строка представляет идентификатор PivotItem. Если на оси, по которой требуется отсортировать, нет элементов, кроме иерархии данных, это может быть пустым.

Возвращает

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);
}