ExcelScript.AutoFilter interface

Paket:

ExcelScript

Stellt das AutoFilter -Objekt dar. AutoFilter wandelt die Werte in der Excel-Spalte basierend auf dem Zellinhalt in bestimmte Filter um.

Hinweise

Beispiele

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column C in the lowest 10 values 
 * (of column C values).
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the autoFilter of the first table in the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();
  const autoFilter = currentSheet.getAutoFilter();

  // Add a filter that will only show the rows with the lowest 10 values in column C
  // (index 2, assuming the used range spans from at least A:C).
  autoFilter.apply(dataRange, 2, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.bottomItems
  });
}

Methoden

apply(range, columnIndex, criteria)	Wendet den AutoFilter auf einen Bereich an. Dies filtert die Spalte, wenn Spaltenindex und Filterkriterien angegeben sind.
clearColumnCriteria(columnIndex)	Löscht die Spaltenfilterkriterien des AutoFilters.
clearCriteria()	Löscht die Filterkriterien und den Sortierstatus des AutoFilters.
getCriteria()	Ein Array, das alle Filterkriterien in dem per AutoFilter gefilterten Bereich enthält.
getEnabled()	Gibt an, ob autoFilter aktiviert ist.
getIsDataFiltered()	Gibt an, ob der AutoFilter Über Filterkriterien verfügt.
getRange()	Gibt das Range -Objekt zurück, das den Bereich darstellt, auf den der AutoFilter angewendet wird. Wenn dem AutoFilter kein Range Objekt zugeordnet ist, gibt diese Methode zurück undefined.
reapply()	Wendet das angegebene AutoFilter-Objekt an, das sich derzeit im Bereich befindet.
remove()	Entfernt den AutoFilter für den Bereich.

Details zur Methode

apply(range, columnIndex, criteria)

Wendet den AutoFilter auf einen Bereich an. Dies filtert die Spalte, wenn Spaltenindex und Filterkriterien angegeben sind.

apply(
            range: Range | string,
            columnIndex?: number,
            criteria?: FilterCriteria
        ): void;

Parameter

range

ExcelScript.Range | string

Der Bereich, auf den der AutoFilter angewendet wird.

columnIndex

number

Der nullbasierte Spaltenindex, auf den der AutoFilter angewendet wird.

criteria

ExcelScript.FilterCriteria

Die Filterkriterien.

Gibt zurück

void

Beispiele

/**
 * This script applies a filter to a table so that 
 * only rows with values in column 1 that start with "L" are shown.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the autoFilter of the first table in the current worksheet.
  const table = workbook.getActiveWorksheet().getTables()[0];
  const autoFilter = table.getAutoFilter();

  // Filter to only include values that start with "L".
  const filterCriteria: ExcelScript.FilterCriteria = {
    filterOn: ExcelScript.FilterOn.custom,
    criterion1: "L*"
  };
  
  // Apply the filter to column 1 (zero-based).
  autoFilter.apply(table.getRange(), 1, filterCriteria);
}

clearColumnCriteria(columnIndex)

Löscht die Spaltenfilterkriterien des AutoFilters.

clearColumnCriteria(columnIndex: number): void;

Parameter

columnIndex

number

Der nullbasierte Spaltenindex, der angibt, welcher Spaltenfilter gelöscht werden muss. Wenn der Indexwert nicht unterstützt wird (z. B. wenn der Wert eine negative Zahl ist oder wenn der Wert größer als die Anzahl der verfügbaren Spalten im Bereich ist), wird ein InvalidArgument Fehler ausgelöst.

Gibt zurück

void

clearCriteria()

Löscht die Filterkriterien und den Sortierstatus des AutoFilters.

clearCriteria(): void;

Gibt zurück

void

Beispiele

/**
 * This script clears any applied criteria from the worksheet's autoFilter.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();

  // Clear all the criteria currently applied to the autoFilter.
  currentSheet.getAutoFilter().clearCriteria();
}

getCriteria()

Ein Array, das alle Filterkriterien in dem per AutoFilter gefilterten Bereich enthält.

getCriteria(): FilterCriteria[];

Gibt zurück

ExcelScript.FilterCriteria[]

getEnabled()

Gibt an, ob autoFilter aktiviert ist.

getEnabled(): boolean;

Gibt zurück

boolean

getIsDataFiltered()

Gibt an, ob der AutoFilter Über Filterkriterien verfügt.

getIsDataFiltered(): boolean;

Gibt zurück

boolean

getRange()

Gibt das Range -Objekt zurück, das den Bereich darstellt, auf den der AutoFilter angewendet wird. Wenn dem AutoFilter kein Range Objekt zugeordnet ist, gibt diese Methode zurück undefined.

getRange(): Range;

Gibt zurück

ExcelScript.Range

reapply()

Wendet das angegebene AutoFilter-Objekt an, das sich derzeit im Bereich befindet.

reapply(): void;

Gibt zurück

void

remove()

Entfernt den AutoFilter für den Bereich.

remove(): void;

Gibt zurück

void