FilterCriteria Object (JavaScript API for Excel)

Represents the filtering criteria applied to a column.

Properties

Property Type Description Req. Set
color string The HTML color string used to filter cells. Used with "cellColor" and "fontColor" filtering. 1.2
criterion1 string The first criterion used to filter data. Used as an operator in the case of "custom" filtering. 1.2
criterion2 string The second criterion used to filter data. Only used as an operator in the case of "custom" filtering. 1.2
dynamicCriteria string The dynamic criteria from the Excel.DynamicFilterCriteria set to apply on this column. Used with "dynamic" filtering. Possible values are: 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. 1.2
filterOn string The property used by the filter to determine whether the values should stay visible. Possible values are: BottomItems, BottomPercent, CellColor, Dynamic, FontColor, Values, TopItems, TopPercent, Icon, Custom. 1.2
operator string The operator used to combine criterion 1 and 2 when using "custom" filtering. Possible values are: And, Or. 1.2
values object[] The set of values to be used as part of "values" filtering. 1.2

See property access examples.

Relationships

Relationship Type Description Req. Set
icon Icon The icon used to filter cells. Used with "icon" filtering. 1.2

Methods

None

ion Req. Set load(param: object) void Fills the proxy object created in JavaScript layer with property and object values specified in the parameter. 1.1

Method Details

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter Type Description  
param object Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.  

Returns

void