ExcelScript.FilterPivotHierarchy interface

Пакет:

ExcelScript

Представляет фильтр ExcelPivotHierarchy.

Замечания

Примеры

/**
 * This script creates a PivotTable with a filter.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the two worksheets to use in PivotTable creation.
  const dataSheet = workbook.getWorksheet("Data");
  const pivotSheet = workbook.getWorksheet("Pivot");

  // Create a new PivotTable.
  const newPivot = pivotSheet.addPivotTable(
    "My PivotTable", 
    dataSheet.getUsedRange(), 
    pivotSheet.getRange("A1"));

  // Add a filter with the Quarter field.
  const filter: ExcelScript.FilterPivotHierarchy = 
    newPivot.addFilterHierarchy(newPivot.getHierarchy("Quarter"));

  // Add other hierarchies...
}

Методика

getEnableMultipleFilterItems()	Определяет, следует ли разрешить несколько элементов фильтра.
getFields()	Возвращает сводные поля, связанные с FilterPivotHierarchy.
getId()	Идентификатор filterPivotHierarchy.
getName()	Имя FilterPivotHierarchy.
getPivotField(name)	Возвращает сводное поле по имени. Если сводное поле не существует, этот метод возвращает undefined.
getPosition()	Положение FilterPivotHierarchy.
setEnableMultipleFilterItems(enableMultipleFilterItems)	Определяет, следует ли разрешить несколько элементов фильтра.
setName(name)	Имя FilterPivotHierarchy.
setPosition(position)	Положение FilterPivotHierarchy.
setToDefault()	Сбрасывает FilterPivotHierarchy до значений по умолчанию.

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

getEnableMultipleFilterItems()

Определяет, следует ли разрешить несколько элементов фильтра.

getEnableMultipleFilterItems(): boolean;

Возвращает

boolean

getFields()

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

getFields(): PivotField[];

Возвращает

ExcelScript.PivotField[]

getId()

Идентификатор filterPivotHierarchy.

getId(): string;

Возвращает

string

getName()

Имя FilterPivotHierarchy.

getName(): string;

Возвращает

string

Примеры

/**
 * This script logs the names of all the filter hierarchies in a PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the first PivotTable in the workbook.
    const pivotTable = workbook.getPivotTables()[0];

    // For each pivot filter, log its name.
    pivotTable.getFilterHierarchies().forEach((filter: ExcelScript.FilterPivotHierarchy) => {
      console.log(filter.getName());
    });
}

getPivotField(name)

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

getPivotField(name: string): PivotField | undefined;

Параметры

name

string

Имя извлекаемого сводного поля.

Возвращает

ExcelScript.PivotField | undefined

getPosition()

Положение FilterPivotHierarchy.

getPosition(): number;

Возвращает

number

setEnableMultipleFilterItems(enableMultipleFilterItems)

Определяет, следует ли разрешить несколько элементов фильтра.

setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;

Параметры

enableMultipleFilterItems

boolean

Возвращает

void

setName(name)

Имя FilterPivotHierarchy.

setName(name: string): void;

Параметры

name

string

Возвращает

void

setPosition(position)

Положение FilterPivotHierarchy.

setPosition(position: number): void;

Параметры

position

number

Возвращает

void

setToDefault()

Сбрасывает FilterPivotHierarchy до значений по умолчанию.

setToDefault(): void;

Возвращает

void