ExcelScript.AutoFilter interface

Пакет:

ExcelScript

Представляет AutoFilter объект . Автофильтр преобразует значения в столбце Excel в определенные фильтры на основе содержимого ячейки.

Комментарии

Примеры

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

Методы

apply(range, columnIndex, criteria)	Применяет автофильтр к диапазону. При этом фильтруется столбец, если указаны индекс столбца и условия фильтрации.
clearColumnCriteria(columnIndex)	Очищает критерии фильтра столбцов автофильтра.
clearCriteria()	Очищает критерии фильтра и состояние сортировки автофильтра.
getCriteria()	Массив, содержащий все условия фильтрации в диапазоне с примененным автофильтром.
getEnabled()	Указывает, включен ли автофильтр.
getIsDataFiltered()	Указывает, имеет ли автофильтр критерии фильтра.
getRange()	Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. Если с автофильтром нет Range объекта, то этот метод возвращает undefined.
reapply()	Применяет указанный объект AutoFilter в данный момент к диапазону.
remove()	Удаляет автофильтр из диапазона.

Сведения о методе

apply(range, columnIndex, criteria)

Применяет автофильтр к диапазону. При этом фильтруется столбец, если указаны индекс столбца и условия фильтрации.

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

Параметры

range

ExcelScript.Range | string

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

columnIndex

number

Отсчитываемый от нуля индекс столбца, к которому применяется автофильтр.

criteria

ExcelScript.FilterCriteria

Критерии фильтра.

Возвращаемое значение

void

Примеры

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

Очищает критерии фильтра столбцов автофильтра.

clearColumnCriteria(columnIndex: number): void;

Параметры

columnIndex

number

Отсчитываемый от нуля индекс столбца, который представляет, какой фильтр столбцов необходимо очистить. Если значение индекса не поддерживается (например, если значение является отрицательным числом или значение больше числа доступных столбцов в диапазоне), то InvalidArgument возникает ошибка.

Возвращаемое значение

void

clearCriteria()

Очищает критерии фильтра и состояние сортировки автофильтра.

clearCriteria(): void;

Возвращаемое значение

void

Примеры

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

Массив, содержащий все условия фильтрации в диапазоне с примененным автофильтром.

getCriteria(): FilterCriteria[];

Возвращаемое значение

ExcelScript.FilterCriteria[]

getEnabled()

Указывает, включен ли автофильтр.

getEnabled(): boolean;

Возвращаемое значение

boolean

getIsDataFiltered()

Указывает, имеет ли автофильтр критерии фильтра.

getIsDataFiltered(): boolean;

Возвращаемое значение

boolean

getRange()

Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. Если с автофильтром нет Range объекта, то этот метод возвращает undefined.

getRange(): Range;

Возвращаемое значение

ExcelScript.Range

reapply()

Применяет указанный объект AutoFilter в данный момент к диапазону.

reapply(): void;

Возвращаемое значение

void

remove()

Удаляет автофильтр из диапазона.

remove(): void;

Возвращаемое значение

void