Full Overlay

Bar Overlay

Function: a!fullOverlay()

Displays an overlay that covers the entire billboard layout

See also: Billboard

Parameters

Name Keyword Type Description
Vertical Alignment alignVertical Text Determines vertical alignment of all content within the overlay. Valid values: "TOP" (default), "MIDDLE", and "BOTTOM".
Contents contents Any Type The interface to display in the overlay. Accepts layouts and display components. Supported layouts and components: Box, Button, Card, Columns, Image, Link, Milestone, Progress Bar, Rich Text, Section, Side By Side.
Visibility showWhen Boolean Determines whether the overlay is displayed on the interface. When set to false, the overlay is hidden and is not evaluated. Default: true.
Style style Text Determines the overlay style. Valid values: "DARK" (default), "LIGHT", "NONE".

Examples

In EXPRESSION MODE, copy and paste an example into the INTERFACE DEFINITION 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
a!billboardLayout(
  backgroundMedia: a!documentImage(
    document: a!EXAMPLE_BILLBOARD_IMAGE()
  ),
  backgroundcolor: "#073763",
  marginBelow: "STANDARD",
  overlay: a!fullOverlay(
    alignvertical: "MIDDLE",
    contents: {
      a!richTextDisplayField(
        labelPosition: "COLLAPSED",
        value: {
          a!richTextItem(text: {"Hello, " & user(loggedinuser(), "firstName") & "."}, size: "MEDIUM"),
          char(10),
          a!richTextItem(text: {"What do you need help with?"}, size: "LARGE")
        },
        align: "CENTER"
      )
    },
    style: "DARK"
  )
)

Displays the following:

Full Overlay Example

FEEDBACK