FilterColumn
FilterColumn class
Represents a filter for a single column.
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. |
| multipleFilters | MultipleFilterCollection | Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time. |
| customFilters | CustomFilterCollection | Gets Aspose.Cells.CustomFilterCollection for filtering data by custom criteria. |
| colorFilter | ColorFilter | Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color. |
| dynamicFilter | DynamicFilter | Readonly. Gets Aspose.Cells.DynamicFilter for filtering with dynamic criteria. |
| iconFilter | IconFilter | Readonly. Gets Aspose.Cells.IconFilter for filtering data by icon. |
| top10Filter | Top10Filter | Readonly. Gets Aspose.Cells.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. |
| getMultipleFilters() | @deprecated. Please use the ‘multipleFilters’ property instead. Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time. |
| setMultipleFilters(MultipleFilterCollection) | @deprecated. Please use the ‘multipleFilters’ property instead. Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time. |
| getCustomFilters() | @deprecated. Please use the ‘customFilters’ property instead. Gets Aspose.Cells.CustomFilterCollection for filtering data by custom criteria. |
| setCustomFilters(CustomFilterCollection) | @deprecated. Please use the ‘customFilters’ property instead. Gets Aspose.Cells.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 Aspose.Cells.DynamicFilter for filtering with dynamic criteria. |
| getIconFilter() | @deprecated. Please use the ‘iconFilter’ property instead. Gets Aspose.Cells.IconFilter for filtering data by icon. |
| getTop10Filter() | @deprecated. Please use the ’top10Filter’ property instead. Gets Aspose.Cells.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. |
| 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 FilterColumn.MultipleFilters,CustomFilters and so on… property according to differnt type of filter 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;
multipleFilters
Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time.
multipleFilters : MultipleFilterCollection;
customFilters
Gets Aspose.Cells.CustomFilterCollection for filtering data by custom criteria.
customFilters : CustomFilterCollection;
colorFilter
Readonly. Gets Aspose.Cells.ColorFilter for filtering data by color.
colorFilter : ColorFilter;
dynamicFilter
Readonly. Gets Aspose.Cells.DynamicFilter for filtering with dynamic criteria.
dynamicFilter : DynamicFilter;
iconFilter
Readonly. Gets Aspose.Cells.IconFilter for filtering data by icon.
iconFilter : IconFilter;
top10Filter
Readonly. Gets Aspose.Cells.Top10Filter for filtering data by rank of data.
top10Filter : Top10Filter;
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
NOTE: This member is now obsolete. Instead,please use FilterColumn.MultipleFilters,CustomFilters and so on… property according to differnt type of filter This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
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
NOTE: This member is now obsolete. Instead,please use FilterColumn.MultipleFilters,CustomFilters and so on… property according to differnt type of filter This property will be removed 12 months later since October 2025. Aspose apologizes for any inconvenience you may have experienced.
getFilterType()
@deprecated. Please use the ‘filterType’ property instead. Gets and sets the type fo filtering data.
getFilterType() : FilterType;
Returns
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. |
getMultipleFilters()
@deprecated. Please use the ‘multipleFilters’ property instead. Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time.
getMultipleFilters() : MultipleFilterCollection;
Returns
setMultipleFilters(MultipleFilterCollection)
@deprecated. Please use the ‘multipleFilters’ property instead. Gets Aspose.Cells.MultipleFilterCollection for filtering data by labels or date time.
setMultipleFilters(value: MultipleFilterCollection) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MultipleFilterCollection | The value to set. |
getCustomFilters()
@deprecated. Please use the ‘customFilters’ property instead. Gets Aspose.Cells.CustomFilterCollection for filtering data by custom criteria.
getCustomFilters() : CustomFilterCollection;
Returns
setCustomFilters(CustomFilterCollection)
@deprecated. Please use the ‘customFilters’ property instead. Gets Aspose.Cells.CustomFilterCollection for filtering data by custom criteria.
setCustomFilters(value: CustomFilterCollection) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CustomFilterCollection | The value to set. |
getColorFilter()
@deprecated. Please use the ‘colorFilter’ property instead. Gets Aspose.Cells.ColorFilter for filtering data by color.
getColorFilter() : ColorFilter;
Returns
getDynamicFilter()
@deprecated. Please use the ‘dynamicFilter’ property instead. Gets Aspose.Cells.DynamicFilter for filtering with dynamic criteria.
getDynamicFilter() : DynamicFilter;
Returns
getIconFilter()
@deprecated. Please use the ‘iconFilter’ property instead. Gets Aspose.Cells.IconFilter for filtering data by icon.
getIconFilter() : IconFilter;
Returns
getTop10Filter()
@deprecated. Please use the ’top10Filter’ property instead. Gets Aspose.Cells.Top10Filter for filtering data by rank of data.
getTop10Filter() : Top10Filter;
Returns
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. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;