SetBackgroundColor
Sets the background color to all cells in the current table row.
Syntax
expression.SetBackgroundColor(color);
expression - A variable that represents an ApiTableRow class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| color | Optional | ApiColor | If not passed, the background color will be cleared. |
Returns
boolean
Example
Set the background color for all cells in a table row in a PDF.
// Color the background of an entire table row in a PDF.
// Set an orange background for the second row in a PDF.
const doc = Api.GetDocument();
const page = doc.GetPage(0);
const table = Api.CreateTable(2, 3);
const row = table.GetRow(1);
row.SetBackgroundColor(Api.RGB(255, 111, 61));
page.AddObject(table);