Bar Overlay

Bar Overlay

Function: a!barOverlay()

Displays a horizontal bar overlay for use in billboard layout.

See also: Billboard

Parameters

Name Keyword Type Description
Position position Text Determines where the bar overlay appears. Valid values: "TOP", "MIDDLE", "BOTTOM" (default).
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
a!billboardLayout(
  backgroundcolor: "#073763",
  marginBelow: "STANDARD",
  overlay: a!barOverlay(
    position: "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:

Bar Overlay Example

The following patterns include usage of the Bar Overlay.

  • Cards as List Items Patterns (Choice Components, Images): The cards as list items pattern is good for creating visually rich interfaces using a combination of cards and billboards to show lists of like items.
FEEDBACK