ColorFilter

ColorFilter class

Represents filtering the range by color.

class ColorFilter;

Constructors

NameDescription
constructor(IObject)Constructs from an IObject convertible to this.

Methods

MethodDescription
getFilterByFillColor()Whether filter by the cell’s fill color.
setFilterByFillColor(boolean)Whether filter by the cell’s fill color.
getColor(WorksheetCollection)Gets the color of this filter.

constructor(IObject)

Constructs from an IObject convertible to this.

constructor(obj: IObject);

Parameters:

ParameterTypeDescription
objIObjectThe object.

getFilterByFillColor()

Whether filter by the cell’s fill color.

getFilterByFillColor() : boolean;

Remarks

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

setFilterByFillColor(boolean)

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