ExcelScript.FilterPivotHierarchy interface

Pacote:

ExcelScript

Representa a FilterPivotHierarchy do Excel.

Comentários

Exemplos

/**
 * 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...
}

Métodos

getEnableMultipleFilterItems()	Determina se deseja permitir vários itens de filtro.
getFields()	Retorna PivotFields associados a FilterPivotHierarchy.
getId()	ID da FilterPivotHierarchy.
getName()	Nome do FilterPivotHierarchy.
getPivotField(name)	Obtém um Campo Dinâmico pelo nome. Se o Campo Dinâmico não existir, este método devolve undefined.
getPosition()	Posição do FilterPivotHierarchy.
setEnableMultipleFilterItems(enableMultipleFilterItems)	Determina se deseja permitir vários itens de filtro.
setName(name)	Nome do FilterPivotHierarchy.
setPosition(position)	Posição do FilterPivotHierarchy.
setToDefault()	Redefina a FilterPivotHierarchy para os valores padrão.

Detalhes do método

getEnableMultipleFilterItems()

Determina se deseja permitir vários itens de filtro.

getEnableMultipleFilterItems(): boolean;

Retornos

boolean

getFields()

Retorna PivotFields associados a FilterPivotHierarchy.

getFields(): PivotField[];

Retornos

ExcelScript.PivotField[]

getId()

ID da FilterPivotHierarchy.

getId(): string;

Retornos

string

getName()

Nome do FilterPivotHierarchy.

getName(): string;

Retornos

string

Exemplos

/**
 * 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)

Obtém um Campo Dinâmico pelo nome. Se o Campo Dinâmico não existir, este método devolve undefined.

getPivotField(name: string): PivotField | undefined;

Parâmetros

name

string

Nome do Campo Dinâmico a obter.

Retornos

ExcelScript.PivotField | undefined

getPosition()

Posição do FilterPivotHierarchy.

getPosition(): number;

Retornos

number

setEnableMultipleFilterItems(enableMultipleFilterItems)

Determina se deseja permitir vários itens de filtro.

setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;

Parâmetros

enableMultipleFilterItems

boolean

Retornos

void

setName(name)

Nome do FilterPivotHierarchy.

setName(name: string): void;

Parâmetros

name

string

Retornos

void

setPosition(position)

Posição do FilterPivotHierarchy.

setPosition(position: number): void;

Parâmetros

position

number

Retornos

void

setToDefault()

Redefina a FilterPivotHierarchy para os valores padrão.

setToDefault(): void;

Retornos

void