Excel.AutoFilter class
Представляет AutoFilter объект. Функция автофильтра преобразует значения в столбце Excel в специальные фильтры в зависимости от содержимого ячеек.
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| criteria | Массив, содержащий все условия фильтрации в диапазоне с примененным автофильтром. |
| enabled | Указывает, включен ли автофильтр. |
| is |
Указывает, есть ли в автофильтре критерии фильтра. |
Методы
| apply(range, column |
Применяет автофильтр к диапазону. При этом фильтруется столбец, если указаны индекс столбца и условия фильтрации. |
| clear |
Очищает условия фильтра столбца автофильтра. |
| clear |
Очищает критерии фильтра и состояние сортировки автофильтра. |
| get |
Возвращает объект, |
| get |
Возвращает объект, |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| reapply() | Применяет указанный объект автофильтра, находящийся в диапазоне. |
| remove() | Удаляет автофильтр из диапазона. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
criteria
Массив, содержащий все условия фильтрации в диапазоне с примененным автофильтром.
readonly criteria: Excel.FilterCriteria[];Значение свойства
Комментарии
enabled
Указывает, включен ли автофильтр.
readonly enabled: boolean;Значение свойства
boolean
Комментарии
isDataFiltered
Указывает, есть ли в автофильтре критерии фильтра.
readonly isDataFiltered: boolean;Значение свойства
boolean
Комментарии
Сведения о методе
apply(range, columnIndex, criteria)
Применяет автофильтр к диапазону. При этом фильтруется столбец, если указаны индекс столбца и условия фильтрации.
apply(range: Range | string, columnIndex?: number, criteria?: Excel.FilterCriteria): void;Параметры
- range
-
Excel.Range | string
Диапазон, к которому будет применен автофильтр.
- columnIndex
-
number
Отсчитываемый от нуля индекс столбца, к которому применяется автофильтр.
- criteria
- Excel.FilterCriteria
Условия фильтрации.
Возвращаемое значение
void
Комментарии
Примеры
// 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();
});
clearColumnCriteria(columnIndex)
Очищает условия фильтра столбца автофильтра.
clearColumnCriteria(columnIndex: number): void;Параметры
- columnIndex
-
number
Индекс столбца, отсчитываемый от нуля, который указывает, какой фильтр столбца необходимо очистить. Если значение индекса не поддерживается (например, если значение отрицательное или значение превышает число доступных столбцов в диапазоне), InvalidArgument то возникает ошибка.
Возвращаемое значение
void
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function clears the AutoFilter setting from one column.
await Excel.run(async (context) => {
// Retrieve the active worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Clear the filter from only column 3.
sheet.autoFilter.clearColumnCriteria(3);
await context.sync();
});
clearCriteria()
Очищает критерии фильтра и состояние сортировки автофильтра.
clearCriteria(): void;Возвращаемое значение
void
Комментарии
getRange()
Возвращает объект, Range представляющий диапазон, к которому применяется автофильтр.
getRange(): Excel.Range;Возвращаемое значение
Комментарии
getRangeOrNullObject()
Возвращает объект, Range представляющий диапазон, к которому применяется автофильтр. Если с автофильтром не Range связан объект, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getRangeOrNullObject(): Excel.Range;Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.AutoFilterLoadOptions): Excel.AutoFilter;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.AutoFilter;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.AutoFilter;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
reapply()
Применяет указанный объект автофильтра, находящийся в диапазоне.
reapply(): void;Возвращаемое значение
void
Комментарии
Примеры
// 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
Комментарии
Примеры
// 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;