ExcelScript.FilterPivotHierarchy interface

Paquet:

ExcelScript

Représente le FilterPivotHierarchy Excel.

Remarques

Utilisateur

• ExcelScript.PivotTable : addFilterHierarchy, getFilterHierarchies, getFilterHierarchy, removeFilterHierarchy

Exemples

/**
 * 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éthodes

getEnableMultipleFilterItems()	Détermine si vous voulez autoriser plusieurs éléments de filtre.
getFields()	Renvoie les PivotFields associés à la FilterPivotHierarchy.
getId()	ID de l’objet FilterPivotHierarchy.
getName()	Nom du filterPivotHierarchy.
getPivotField(name)	Obtient un champ de tableau croisé dynamique par nom. Si le champ de tableau croisé dynamique n’existe pas, cette méthode retourne undefined.
getPosition()	Position du filterPivotHierarchy.
setEnableMultipleFilterItems(enableMultipleFilterItems)	Détermine si vous voulez autoriser plusieurs éléments de filtre.
setName(name)	Nom du filterPivotHierarchy.
setPosition(position)	Position du filterPivotHierarchy.
setToDefault()	Restaurer la FilterPivotHierarchy à ses valeurs par défaut.

Détails de la méthode

getEnableMultipleFilterItems()

Détermine si vous voulez autoriser plusieurs éléments de filtre.

getEnableMultipleFilterItems(): boolean;

Retours

boolean

getFields()

Renvoie les PivotFields associés à la FilterPivotHierarchy.

getFields(): PivotField[];

Retours

ExcelScript.PivotField[]

getId()

ID de l’objet FilterPivotHierarchy.

getId(): string;

Retours

string

getName()

Nom du filterPivotHierarchy.

getName(): string;

Retours

string

Exemples

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

Obtient un champ de tableau croisé dynamique par nom. Si le champ de tableau croisé dynamique n’existe pas, cette méthode retourne undefined.

getPivotField(name: string): PivotField | undefined;

Paramètres

name

string

Nom du champ de tableau croisé dynamique à récupérer.

Retours

ExcelScript.PivotField | undefined

getPosition()

Position du filterPivotHierarchy.

getPosition(): number;

Retours

number

setEnableMultipleFilterItems(enableMultipleFilterItems)

Détermine si vous voulez autoriser plusieurs éléments de filtre.

setEnableMultipleFilterItems(enableMultipleFilterItems: boolean): void;

Paramètres

enableMultipleFilterItems

boolean

Retours

void

setName(name)

Nom du filterPivotHierarchy.

setName(name: string): void;

Paramètres

name

string

Retours

void

setPosition(position)

Position du filterPivotHierarchy.

setPosition(position: number): void;

Paramètres

position

number

Retours

void

setToDefault()

Restaurer la FilterPivotHierarchy à ses valeurs par défaut.

setToDefault(): void;

Retours

void