This page contains information related to an old version of the Billboard Layout Component.
To take advantage of the latest features and improvements, we always recommend you use the latest version whenever possible. See the latest version's page for information about what's been changed.
Function: a!billboardLayout_19r1()
Displays a background color, image, or video with optional overlay content.
Parameters
Name | Keyword | Type | Description |
---|---|---|---|
Background Media | backgroundMedia | Any Type | Determines the background content. Takes priority over background color. Configure with a!documentImage(), a!webImage(), or a!webVideo() |
Background Color | backgroundColor | Text | Determines the background color. When background media is also specified, the background color shows while media is loading or when background image is transparent. Must be a valid hex code. Default is #f0f0f0 . |
Bar Overlay Position | overlayPositionBar | Text | Determines where the bar overlay appears. Takes priority over column overlay when both are specified. Valid values: "TOP" , "MIDDLE" , "BOTTOM" (default). |
Column Overlay Position | overlayPositionColumn | Text | Determines where the column overlay appears. Ignored when a bar overlay is also specified. Valid values: "START" , "CENTER" , "END" . |
Column Overlay Width | overlayColumnWidth | Text | Determines the column overlay width. Ignored when a bar overlay is also specified. Valid values: "NARROW" , "MEDIUM" (default), "WIDE" . |
Overlay Style | overlayStyle | Text | Determines the overlay style. Valid values: "DARK" (default), "LIGHT" , "NONE" . |
Overlay Contents | overlayContents | Any Type | The interface to display on top of the background. Accepts layouts and display components. Supported layouts and components: Button, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side by Side. |
Height | height | Text | Determines the layout height. Valid values: "SHORT" , "MEDIUM" (default), "TALL" . |
Visibility | showWhen | Boolean | Determines whether the layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true. |
Margin Below | marginBelow | Text | Determines how much space is added below the layout. Valid values: “NONE” (default), “STANDARD” . |
Notes
Examples
Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
=a!billboardLayout_19r1(
backgroundColor: "#619ed6",
overlayPositionBar: "BOTTOM",
overlayStyle: "DARK",
overlayContents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
labelPosition: "COLLAPSED",
value: {
a!richTextItem(
text: "Finance Summary",
size: "LARGE"
)
}
)
}
),
a!columnLayout(
contents: {
a!columnsLayout(
columns: {
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Total Spending",
value: a!richTextItem(
text: "$31,000.00",
size: "MEDIUM"
)
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Remaining Budget",
value: a!richTextItem(
text: a!richTextItem(
text: "79%",
size: "MEDIUM"
),
color: "POSITIVE"
)
)
}
),
a!columnLayout(
contents: {
a!richTextDisplayField(
label: "Open Requests",
value: a!richTextItem(
text: "36",
size: "MEDIUM"
)
)
}
)
},
alignVertical: "TOP"
)
}
)
},
alignVertical: "MIDDLE"
)
},
height: "SHORT",
marginBelow: "STANDARD"
)
Displays the following:
a!billboardLayout_19r1 Component