Read-Only Grid Column Component

Grid Column

Function: a!gridColumn()

Displays a column of data as read-only text, links, images, or rich text within the Read-Only Grid Component.

When configuring the component, click Display Options after choosing a value.

grid_column_display_options.png

Parameters

Name Keyword Types Description

Label

label

Text

Text to display as the column header.

Sort Field

sortField

Text

The name of the field that the data should be sorted by when the user sorts by this column.

Help Tooltip

helpTooltip

Text

Displays a help icon in the column header with the specified text as a tooltip.

Display Value

value

Any Type

The value to display in each cell within the column. The value can be text, a!imageField(), a!linkField(), or a!richTextDisplayField(). It is evaluated once for each row. You can reference the fields from the data source using fv!row and the field name in dot notation (fv!row.fieldName). For example, if your source is a data store entity, you can reference the "status" field using fv!row.status. You can also reference the identifier of the row using fv!identifier.

Visibility

showWhen

Boolean

Determines whether the column is displayed in the grid. When set to false, the column is hidden and is not evaluated. Default: true.

Alignment

align

Text

Determines the alignment for the header label and all values within the column. Valid values: "START" (default), "CENTER", "END".

Width

width

Text

Determines the column width. Valid values: "AUTO", "ICON", "ICON_PLUS", "NARROW", "NARROW_PLUS", "MEDIUM", "MEDIUM_PLUS", "WIDE", "1X", "2X", "3X", "4X", "5X", "6X", "7X", "8X", "9X", and "10X".

The following patterns include usage of the Read-Only Grid Column Component.

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!gridTextColumn

Now supports multiple interface components.

a!gridImageColumn

Now supports multiple interface components.

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

FEEDBACK