ColorFilter

ColorFilter class

Represents filtering the range by color.

class ColorFilter;

Constructors

Constructor	Description
constructor(Object)	Constructs from an Object convertible to this.

Properties

Property	Type	Description
filterByFillColor	boolean	Whether filter by the cell’s fill color.

Methods

Method	Description
getFilterByFillColor()	@deprecated. Please use the ‘filterByFillColor’ property instead. Whether filter by the cell’s fill color.
setFilterByFillColor(boolean)	@deprecated. Please use the ‘filterByFillColor’ property instead. Whether filter by the cell’s fill color.
getColor(WorksheetCollection)	Gets the color of this filter.
isNull()	Checks whether the implementation object is null.
toObject()	Gets the Object.

constructor(Object)

Constructs from an Object convertible to this.

constructor(obj: Object);

Parameters:

Parameter	Type	Description
obj	Object	The object.

filterByFillColor

Whether filter by the cell’s fill color.

filterByFillColor : boolean;

Remarks

True: cell’s fill color; False: cell’s font color.

getFilterByFillColor()

@deprecated. Please use the ‘filterByFillColor’ property instead. Whether filter by the cell’s fill color.

getFilterByFillColor() : boolean;

Remarks

True: cell’s fill color; False: cell’s font color.

setFilterByFillColor(boolean)

@deprecated. Please use the ‘filterByFillColor’ property instead. Whether filter by the cell’s fill color.

setFilterByFillColor(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

True: cell’s fill color; False: cell’s font color.

getColor(WorksheetCollection)

Gets the color of this filter.

getColor(sheets: WorksheetCollection) : Color;

Parameters:

Parameter	Type	Description
sheets	WorksheetCollection

Returns

Color

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

toObject()

Gets the Object.

toObject() : Object;