Dashboard Layout

Dashboard layout is no longer necessary when creating interfaces. Designers can simply wrap their other components in an array, {}.

Function

a!dashboardLayout( contents, showWhen )

Displays any arrangement of layouts and components. Use this as the top-level layout for record views and Tempo reports.

See also: Form, Columns

Parameters

Name Keyword Types Description

Contents

contents

Any Type Array

Components and layouts to display in the dashboard body.

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.

Examples

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

Single-column dashboard

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
a!dashboardLayout(
  contents: {
    a!textField(
      label: "Customer",
      value: "John Smith",
      readOnly: true
    ),
    a!textField(
      label: "Status",
      value: "Prospective",
      readOnly: true
    ),
    a!textField(
      label: "Priority",
      value: "High",
      readOnly: true
    )
  }
)

Displays the following:

screenshot of a single column dashboard{screenshot}

Two-column dashboard

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
a!dashboardLayout(
  contents: {
    a!columnsLayout(
      columns: {
        a!columnLayout(
          contents: {
            a!textField(
              label: "Customer",
              value: "John Smith",
              readOnly: true
            ),
            a!textField(
              label: "Status",
              value: "Prospective",
              readOnly: true
            ),
            a!textField(
              label: "Priority",
              value: "High",
              readOnly: true
            )
          }
        ),
        a!columnLayout(
          contents: {
            a!textField(
              label: "Customer",
              value: "Michael Johnson",
              readOnly: true
            ),
            a!textField(
              label: "Status",
              value: "Prospective",
              readOnly: true
            ),
            a!textField(
              label: "Priority",
              value: "Medium",
              readOnly: true
            )
          }
        )
      }
    )    
  }
)

Displays the following:

screenshot of a dashboard with two columns{screenshot}

Old Versions

There are older versions of this Interface Component. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

Old Versions Reason for Update
a!dashboardLayout_17r1

Replaced firstColumnContents and secondColumnContents with contents. Now supports greater than two-column layout.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

Open in Github

On This Page

FEEDBACK