FilterColumn

FilterColumn class

Represents a filter for a single column or a column in the table.

class FilterColumn;

Properties

Property	Type	Description
isDropdownVisible	boolean	Indicates whether the AutoFilter button for this column is visible.
filter	Object	Gets and sets the condition of filtering data.
filterType	FilterType	Gets and sets the type fo filtering data.
filterValues	FilterValueCollection	Readonly. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time.
multipleFilters	MultipleFilterCollection	Gets MultipleFilterCollection for filtering data by labels or date time.
customFilters	CustomFilterCollection	Gets CustomFilterCollection for filtering data by custom criteria.
colorFilter	ColorFilter	Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color.
dynamicFilter	DynamicFilter	Readonly. Gets DynamicFilter for filtering with dynamic criteria.
iconFilter	IconFilter	Readonly. Gets IconFilter for filtering data by icon.
top10Filter	Top10Filter	Readonly. Gets Top10Filter for filtering data by rank of data.
fieldIndex	number	Gets and sets the column offset in the range.

Methods

Method	Description
isDropdownVisible()	@deprecated. Please use the ‘isDropdownVisible’ property instead. Indicates whether the AutoFilter button for this column is visible.
setIsDropdownVisible(boolean)	@deprecated. Please use the ‘isDropdownVisible’ property instead. Indicates whether the AutoFilter button for this column is visible.
getFilter()	@deprecated. Please use the ‘filter’ property instead. Gets and sets the condition of filtering data.
setFilter(Object)	@deprecated. Please use the ‘filter’ property instead. Gets and sets the condition of filtering data.
getFilterType()	@deprecated. Please use the ‘filterType’ property instead. Gets and sets the type fo filtering data.
setFilterType(FilterType)	@deprecated. Please use the ‘filterType’ property instead. Gets and sets the type fo filtering data.
getFilterValues()	@deprecated. Please use the ‘filterValues’ property instead. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time.
getMultipleFilters()	@deprecated. Please use the ‘multipleFilters’ property instead. Gets MultipleFilterCollection for filtering data by labels or date time.
setMultipleFilters(MultipleFilterCollection)	@deprecated. Please use the ‘multipleFilters’ property instead. Gets MultipleFilterCollection for filtering data by labels or date time.
getCustomFilters()	@deprecated. Please use the ‘customFilters’ property instead. Gets CustomFilterCollection for filtering data by custom criteria.
setCustomFilters(CustomFilterCollection)	@deprecated. Please use the ‘customFilters’ property instead. Gets CustomFilterCollection for filtering data by custom criteria.
getColorFilter()	@deprecated. Please use the ‘colorFilter’ property instead. Gets Aspose.Cells.ColorFilter for filtering data by color.
getDynamicFilter()	@deprecated. Please use the ‘dynamicFilter’ property instead. Gets DynamicFilter for filtering with dynamic criteria.
getIconFilter()	@deprecated. Please use the ‘iconFilter’ property instead. Gets IconFilter for filtering data by icon.
getTop10Filter()	@deprecated. Please use the ’top10Filter’ property instead. Gets Top10Filter for filtering data by rank of data.
getFieldIndex()	@deprecated. Please use the ‘fieldIndex’ property instead. Gets and sets the column offset in the range.
setFieldIndex(number)	@deprecated. Please use the ‘fieldIndex’ property instead. Gets and sets the column offset in the range.
selectAll()	Selects all.
isNull()	Checks whether the implementation object is null.

isDropdownVisible

Indicates whether the AutoFilter button for this column is visible.

isDropdownVisible : boolean;

filter

Gets and sets the condition of filtering data.

filter : Object;

Remarks

NOTE: This member is now obsolete. Instead, please use corresponding property according to FilterColumn.FilterType. And for filter type FilterType.MultipleFilters, the returned object is FilterValueCollection now instead of MultipleFilterCollection. This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.

filterType

Gets and sets the type fo filtering data.

filterType : FilterType;

Remarks

The corresponding filter object will be created when this property is set and corresponding property should be used to get the filter object accordingly: FilterType Property MultipleFilters FilterColumn.FilterValues CustomFilters FilterColumn.CustomFilters ColorFilter FilterColumn.ColorFilter DynamicFilter FilterColumn.DynamicFilter IconFilter FilterColumn.IconFilter Top10 FilterColumn.Top10Filter </list

filterValues

Readonly. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time.

filterValues : FilterValueCollection;

Remarks

Sets FilterColumn.FilterType as FilterType.MultipleFilters first,otherwise Null will be returned.

multipleFilters

Gets MultipleFilterCollection for filtering data by labels or date time.

multipleFilters : MultipleFilterCollection;

Remarks

NOTE: This member is now obsolete. Instead,please use FilterColumn.FilterValues property . This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

customFilters

Gets CustomFilterCollection for filtering data by custom criteria.

customFilters : CustomFilterCollection;

Remarks

NOTE: This setter of this propery is now obsolete. Instead,please use property FilterColumn.FilterType by setting it as FilterType.CustomFilters. This property will be removed 12 months later since June 2026. Aspose apologizes for any inconvenience you may have experienced.

colorFilter

Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color.

colorFilter : ColorFilter;

Remarks

Sets FilterType as FilterType.ColorFilter first,otherwise Null will be returned.

dynamicFilter

Readonly. Gets DynamicFilter for filtering with dynamic criteria.

dynamicFilter : DynamicFilter;

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.DynamicFilter, otherwise null will be returned.

iconFilter

Readonly. Gets IconFilter for filtering data by icon.

iconFilter : IconFilter;

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.IconFilter, otherwise null will be returned.

top10Filter

Readonly. Gets Top10Filter for filtering data by rank of data.

top10Filter : Top10Filter;

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.Top10, otherwise null will be returned.

fieldIndex

Gets and sets the column offset in the range.

fieldIndex : number;

isDropdownVisible()

@deprecated. Please use the ‘isDropdownVisible’ property instead. Indicates whether the AutoFilter button for this column is visible.

isDropdownVisible() : boolean;

setIsDropdownVisible(boolean)

@deprecated. Please use the ‘isDropdownVisible’ property instead. Indicates whether the AutoFilter button for this column is visible.

setIsDropdownVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getFilter()

@deprecated. Please use the ‘filter’ property instead. Gets and sets the condition of filtering data.

getFilter() : Object;

Remarks

setFilter(Object)

@deprecated. Please use the ‘filter’ property instead. Gets and sets the condition of filtering data.

setFilter(value: Object) : void;

Parameters:

Parameter	Type	Description
value	Object	The value to set.

Remarks

getFilterType()

@deprecated. Please use the ‘filterType’ property instead. Gets and sets the type fo filtering data.

getFilterType() : FilterType;

Returns

FilterType

Remarks

setFilterType(FilterType)

@deprecated. Please use the ‘filterType’ property instead. Gets and sets the type fo filtering data.

setFilterType(value: FilterType) : void;

Parameters:

Parameter	Type	Description
value	FilterType	The value to set.

Remarks

getFilterValues()

@deprecated. Please use the ‘filterValues’ property instead. Gets Aspose.Cells.FilterValueCollection for filtering data by labels or date time.

getFilterValues() : FilterValueCollection;

Returns

FilterValueCollection

Remarks

Sets FilterColumn.FilterType as FilterType.MultipleFilters first,otherwise Null will be returned.

getMultipleFilters()

@deprecated. Please use the ‘multipleFilters’ property instead. Gets MultipleFilterCollection for filtering data by labels or date time.

getMultipleFilters() : MultipleFilterCollection;

Returns

MultipleFilterCollection

Remarks

setMultipleFilters(MultipleFilterCollection)

@deprecated. Please use the ‘multipleFilters’ property instead. Gets MultipleFilterCollection for filtering data by labels or date time.

setMultipleFilters(value: MultipleFilterCollection) : void;

Parameters:

Parameter	Type	Description
value	MultipleFilterCollection	The value to set.

Remarks

getCustomFilters()

@deprecated. Please use the ‘customFilters’ property instead. Gets CustomFilterCollection for filtering data by custom criteria.

getCustomFilters() : CustomFilterCollection;

Returns

CustomFilterCollection

Remarks

setCustomFilters(CustomFilterCollection)

@deprecated. Please use the ‘customFilters’ property instead. Gets CustomFilterCollection for filtering data by custom criteria.

setCustomFilters(value: CustomFilterCollection) : void;

Parameters:

Parameter	Type	Description
value	CustomFilterCollection	The value to set.

Remarks

getColorFilter()

@deprecated. Please use the ‘colorFilter’ property instead. Gets Aspose.Cells.ColorFilter for filtering data by color.

getColorFilter() : ColorFilter;

Returns

ColorFilter

Remarks

Sets FilterType as FilterType.ColorFilter first,otherwise Null will be returned.

getDynamicFilter()

@deprecated. Please use the ‘dynamicFilter’ property instead. Gets DynamicFilter for filtering with dynamic criteria.

getDynamicFilter() : DynamicFilter;

Returns

DynamicFilter

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.DynamicFilter, otherwise null will be returned.

getIconFilter()

@deprecated. Please use the ‘iconFilter’ property instead. Gets IconFilter for filtering data by icon.

getIconFilter() : IconFilter;

Returns

IconFilter

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.IconFilter, otherwise null will be returned.

getTop10Filter()

@deprecated. Please use the ’top10Filter’ property instead. Gets Top10Filter for filtering data by rank of data.

getTop10Filter() : Top10Filter;

Returns

Top10Filter

Remarks

Before using this property, please make sure FilterColumn.FilterType is FilterType.Top10, otherwise null will be returned.

getFieldIndex()

@deprecated. Please use the ‘fieldIndex’ property instead. Gets and sets the column offset in the range.

getFieldIndex() : number;

setFieldIndex(number)

@deprecated. Please use the ‘fieldIndex’ property instead. Gets and sets the column offset in the range.

setFieldIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

selectAll()

Selects all.

selectAll() : void;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;