Excel.FilterCriteria interface

Represents the filtering criteria applied to a column.

[ API set: ExcelApi 1.2 ]

Properties

color

The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering.

[ API set: ExcelApi 1.2 ]

criterion1

The first criterion used to filter data. Used as an operator in the case of "custom" filtering. For example ">50" for number greater than 50 or "=*s" for values ending in "s".

Used as a number in the case of top/bottom items/percents. E.g. "5" for the top 5 items if filterOn is set to "topItems"

[ API set: ExcelApi 1.2 ]

criterion2

The second criterion used to filter data. Only used as an operator in the case of "custom" filtering.

[ API set: ExcelApi 1.2 ]

dynamicCriteria

The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering.

[ API set: ExcelApi 1.2 ]

filterOn

The property used by the filter to determine whether the values should stay visible.

[ API set: ExcelApi 1.2 ]

icon

The icon used to filter cells. Used with "icon" filtering.

[ API set: ExcelApi 1.2 ]

operator

The operator used to combine criterion 1 and 2 when using "custom" filtering.

[ API set: ExcelApi 1.2 ]

values

The set of values to be used as part of "values" filtering.

[ API set: ExcelApi 1.2 ]

Property Details

color

The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering.

[ API set: ExcelApi 1.2 ]

color?: string;
Property Value
string

criterion1

The first criterion used to filter data. Used as an operator in the case of "custom" filtering. For example ">50" for number greater than 50 or "=*s" for values ending in "s".

Used as a number in the case of top/bottom items/percents. E.g. "5" for the top 5 items if filterOn is set to "topItems"

[ API set: ExcelApi 1.2 ]

criterion1?: string;
Property Value
string

criterion2

The second criterion used to filter data. Only used as an operator in the case of "custom" filtering.

[ API set: ExcelApi 1.2 ]

criterion2?: string;
Property Value
string

dynamicCriteria

The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering.

[ API set: ExcelApi 1.2 ]

dynamicCriteria?: Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday";
Property Value
Excel.DynamicFilterCriteria | "Unknown" | "AboveAverage" | "AllDatesInPeriodApril" | "AllDatesInPeriodAugust" | "AllDatesInPeriodDecember" | "AllDatesInPeriodFebruray" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodJuly" | "AllDatesInPeriodJune" | "AllDatesInPeriodMarch" | "AllDatesInPeriodMay" | "AllDatesInPeriodNovember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodSeptember" | "BelowAverage" | "LastMonth" | "LastQuarter" | "LastWeek" | "LastYear" | "NextMonth" | "NextQuarter" | "NextWeek" | "NextYear" | "ThisMonth" | "ThisQuarter" | "ThisWeek" | "ThisYear" | "Today" | "Tomorrow" | "YearToDate" | "Yesterday"

filterOn

The property used by the filter to determine whether the values should stay visible.

[ API set: ExcelApi 1.2 ]

filterOn: Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom";
Property Value
Excel.FilterOn | "BottomItems" | "BottomPercent" | "CellColor" | "Dynamic" | "FontColor" | "Values" | "TopItems" | "TopPercent" | "Icon" | "Custom"

icon

The icon used to filter cells. Used with "icon" filtering.

[ API set: ExcelApi 1.2 ]

icon?: Excel.Icon;
Property Value

operator

The operator used to combine criterion 1 and 2 when using "custom" filtering.

[ API set: ExcelApi 1.2 ]

operator?: Excel.FilterOperator | "And" | "Or";
Property Value
Excel.FilterOperator | "And" | "Or"

values

The set of values to be used as part of "values" filtering.

[ API set: ExcelApi 1.2 ]

values?: Array<string | FilterDatetime>;
Property Value
Array<string | FilterDatetime>