IColorOperations interface

📖 Description

Describes the operations interface for the color function.

📃 Type declaration

interface IColorOperations {
  manipulate: (manipulation: (color: Color) => Color, condition?: boolean) => IColorOperations;Function
  makeBlackOrWhite: (condition?: boolean) => IColorOperations;Function
  makeUnclear: (color: string) => IColorOperations;Function
}

🖱️ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

▶️ Functions

---

🔧 makeBlackOrWhite

Evaluates the color and makes it black or white.

Signature

(condition?: boolean) => IColorOperations

Parameters

Name	Type	Optional	Description
condition	boolean	Yes	Specifies an optional condition. When this argument is false, the operation is not applied.

Return value

Returns a reference to the IColorOperations object.

---

🔧 makeUnclear

Specifies a color in case the color is transparent.

Signature

(color: string) => IColorOperations

Parameters

Name	Type	Optional	Description
color	string	No	Specifies the color to use.

Return value

Returns a reference to the IColorOperations object.

---

🔧 manipulate

Manipulate a color.

Signature

(manipulation: (color: Color) => Color, condition?: boolean) => IColorOperations

Parameters

Name	Type	Optional	Description
manipulation	(color: Color) => Color	No	Specifies the color manipulation function.
condition	boolean	Yes	Specifies an optional condition. When this argument is false, the manipulation is not applied.

Return value

Returns a reference to the IColorOperations object.