ColorFilter

ColorFilter class

Represents filtering the range by color.

class ColorFilter;

Constructors

ConstructorDescription
constructor(Object)Constructs from an Object convertible to this.

Properties

PropertyTypeDescription
filterByFillColorbooleanWhether filter by the cell’s fill color.

Methods

MethodDescription
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:

ParameterTypeDescription
objObjectThe 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:

ParameterTypeDescription
valuebooleanThe 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:

ParameterTypeDescription
sheetsWorksheetCollection

Returns

Color

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

toObject()

Gets the Object.

toObject() : Object;