ColorFilter
Contents
[
Hide
]ColorFilter class
Represents filtering the range by color.
class ColorFilter;
Constructors
| Name | Description |
|---|---|
| constructor(Object) | Constructs from an Object convertible to this. |
Methods
| Method | Description |
|---|---|
| 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. |
| 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. |
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:
| 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
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
toObject()
Gets the Object.
toObject() : Object;
Returns