Поделиться через

Excel.AutoFilter class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
criteria

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

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

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

Методы

apply(range, columnIndex, criteria)

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

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

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

Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. Если объект, связанный с автофильтром, отсутствует Range , то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
reapply()

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

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

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.AutoFilter является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.AutoFilterData), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

criteria

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

readonly criteria: Excel.FilterCriteria[];

Значение свойства

Excel.FilterCriteria[]

Комментарии

[ Набор API: ExcelApi 1.9 ]

enabled

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

readonly enabled: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

isDataFiltered

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

readonly isDataFiltered: boolean;

Значение свойства

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

apply(range, columnIndex, criteria)

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

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

Параметры

range

Excel.Range | string

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

columnIndex

number

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

criteria
Excel.FilterCriteria

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

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

clearCriteria()

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

clearCriteria(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

getRange()

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

getRange(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.9 ]

getRangeOrNullObject()

Range Возвращает объект , представляющий диапазон, к которому применяется автофильтр. Если объект, связанный с автофильтром, отсутствует Range , то этот метод возвращает объект со свойством isNullObject , равным true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getRangeOrNullObject(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.9 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter;

Параметры

options
Excel.Interfaces.AutoFilterLoadOptions

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

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

Excel.AutoFilter

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.AutoFilter;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Excel.AutoFilter

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.AutoFilter;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Excel.AutoFilter

reapply()

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

reapply(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function refreshes the AutoFilter to ensure that changes are captured.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Reapply the filter to capture changes.
    sheet.autoFilter.reapply();
    await context.sync();
});

remove()

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

remove(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function removes all AutoFilters from the active worksheet.
await Excel.run(async (context) => {
    // Retrieve the active worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // Remove all filters.
    sheet.autoFilter.remove();
    await context.sync();
});

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.AutoFilter является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.AutoFilterData), который содержит мелкие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.AutoFilterData;

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

Excel.Interfaces.AutoFilterData