Free cookie consent management tool by TermsFeed Read-Only Grid Column Component (a!gridColumn)
Read-Only Grid Column Component
This function cannot be used with Custom Record Field Expressions.
For a full list of functions and their feature compatibility, explore the Appian Functions table.


a!gridColumn( label, sortField, helpTooltip, value, showWhen, align, width )

Displays a column of data as read-only text, links, images, rich text, buttons, tags, record actions, or progress bars within the Read-Only Grid Component.

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

Grid column display options dialog

See also: Grids design guidance


Name Keyword Types Description




Text to display as the column header.

Sort Field


Any Type

The field used to sort the grid when selecting this column header. Grids that use record data must use the recordType! domain to reference a record field or related record field. For example, recordType!Case.fields.caseName.

Help Tooltip



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

Display Value


Any Type

The value to display in each cell within the column. The value can be text, a!imageField(), a!linkField(), a!richTextDisplayField(), a!tagField(), a!buttonArrayLayout(), a!recordActionField(), or a!progressBarField(). It is evaluated once for each row. Reference fields from the source using dot notation, such as fv!row.status, or the identifier using fv!identifier. Grids that use record data must use the recordType! domain to reference a record field or related record field. For example, fv!row[recordType!Case.fields.caseName].




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




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




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".

Usage considerations

Using the value parameter

  • If the value parameter for a column is empty or null, the grid still renders the column with just the label.
  • If the value parameter contains a data query, each row of the column may be evaluated in parallel to reduce the overall evaluation time of the grid.

Using the width parameter

  • For columns using the "AUTO" width, the width is determined by the length of the longest unbroken value in that column.
    • For example, this could be the length of the longest word in a paragraph or the width of the widest image.
  • Avoid using "AUTO" and weighted column widths (such as "1X", "2X", "3X", etc) together.
  • If you use a fixed width (such as "NARROW", "MEDIUM", etc) for a column that doesn't take up the width of the page, the width will auto distribute depending on the content inside the column.
  • If you use "ICON" & "AUTO" widths together, the column using "ICON" will always be the same width and the column using "AUTO" will fill up the remaining space.
  • For complete guidance on when and how to use column widths, see Column Widths.

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

Now supports multiple interface components.


Now supports multiple interface components.

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

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

Open in Github Built: Fri, Nov 10, 2023 (03:42:48 PM)

Read-Only Grid Column Component