Full Overlay
This SAIL component may not be compatible with all features of Appian. For details, see the Feature Compatibility section below.

Function

a!fullOverlay( alignVertical, contents, showWhen, style )

Displays an overlay that covers the entire billboard layout.

See also: Billboard, Billboard layout design guidance

Parameters

Name Keyword Types 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 layout is displayed on the interface. When set to false, the layout is hidden and is not evaluated. Default: true.

Style

style

Text

Determines the overlay style. Valid values: "DARK" (default), "SEMI_DARK", "NONE", "SEMI_LIGHT", "LIGHT".

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Full overlay with intro message

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

Feature compatibility

The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Custom Record Field Expressions Incompatible
Open in Github Built: Fri, Aug 12, 2022 (09:54:06 AM)

On This Page

FEEDBACK