FilterColumn

FilterColumn class

Represents a filter for a single column. The Filter object is a member of the Filters collection

class FilterColumn;

Properties

PropertyTypeDescription
isDropdownVisiblebooleanIndicates whether the AutoFilter button for this column is visible.
filterObjectGets and sets the condition of filtering data.
filterTypeFilterTypeGets and sets the type fo filtering data.
fieldIndexnumberGets and sets the column offset in the range.

Methods

MethodDescription
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.
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;

filterType

Gets and sets the type fo filtering data.

filterType : FilterType;

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:

ParameterTypeDescription
valuebooleanThe value to set.

getFilter()

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

getFilter() : Object;

setFilter(Object)

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

setFilter(value: Object) : void;

Parameters:

ParameterTypeDescription
valueObjectThe value to set.

getFilterType()

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

getFilterType() : FilterType;

Returns

FilterType

setFilterType(FilterType)

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

setFilterType(value: FilterType) : void;

Parameters:

ParameterTypeDescription
valueFilterTypeThe value to set.

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:

ParameterTypeDescription
valuenumberThe value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;