Description
Paints (colors) the specified app object(s).
Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| tokensOrNames | Text | Yes | Comma-seperated list of app object token(s) or name(s) |
| [on] | Boolean | No | Paint toggle (true = paint, false = unpaint) |
| [color] | Text | No | Desired color in hex format (#RRGGBB) |
| [opacity] | Number | No | Opacity value from 0 (transparent) to 1 (opaque) |
Returns
No return value.
Examples
// paint app objects [10] and [15] using default settings
app.paint("[10], [15]");
// paint app objects [10] and [15] blue with 25% opacity
app.paint("[10], [15]", true, "#0000FF", 0.25);
// paint app objects [10] and [15] using the built-in 'info' color
app.paint("[10], [15]", true, "info");
Remarks
In addition to being able to specify a custom color and opacity, the runtime supports a few standard colors you can use by specifying their name:
| Name 1 | Name 2 | Description |
|---|---|---|
| Warning | Red | A light-red color |
| Alert | Yellow | A light-yellow color |
| Insight | Green | A light-green color |
| Info | Blue | A light-blue color |
Token Syntax
This function uses the native app object token syntax, which refers to the ID of an object within your app that is enclosed in square brackets.
Example: [10]