Editable Grid Header Component

Function

a!gridLayoutHeaderCell( label, helpTooltip, align, showWhen )

Defines a column header for use in an Editable Grid.

See also: Grids design guidance

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the column header.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip.

Alignment

align

Text

Determines the header label's alignment. Valid values: "LEFT", "CENTER", "RIGHT".

Visibility

showWhen

Boolean

Determines whether the header cell is displayed in the grid. When set to false, the header cell 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.

Grid header with a label

This example needs to be used with the a!gridLayout() function for it to display anything. Examples that you can see in action are available in the Grid Layout component section.

1
2
3
4
a!gridLayoutHeaderCell(
  label: "Total",
  align: "RIGHT"
)

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
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Editable Grid Header Component.

Open in Github Built: Fri, Dec 02, 2022 (04:35:05 PM)

On This Page

FEEDBACK