ExcelScript.FilterPivotHierarchy interface

包:

ExcelScript

表示 Excel FilterPivotHierarchy。

注解

示例

/**
 * 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 相关联的 PivotFields。
getId()	FilterPivotHierarchy 的 ID。
getName()	FilterPivotHierarchy 的名称。
getPivotField(name)	按名称获取透视字段。 如果 PivotField 不存在，则此方法返回 undefined。
getPosition()	FilterPivotHierarchy 的位置。
setEnableMultipleFilterItems(enableMultipleFilterItems)	确定是否允许多个筛选项。
setName(name)	FilterPivotHierarchy 的名称。
setPosition(position)	FilterPivotHierarchy 的位置。
setToDefault()	将 FilterPivotHierarchy 重置回其默认值。

方法详细信息

getEnableMultipleFilterItems()

确定是否允许多个筛选项。

getEnableMultipleFilterItems(): boolean;

返回

boolean

getFields()

返回与 FilterPivotHierarchy 相关联的 PivotFields。

getFields(): PivotField[];

返回

ExcelScript.PivotField[]

getId()

FilterPivotHierarchy 的 ID。

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)

按名称获取透视字段。 如果 PivotField 不存在，则此方法返回 undefined。

getPivotField(name: string): PivotField | undefined;

参数

name

string

要检索的 PivotField 的名称。

返回

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