Free cookie consent management tool by TermsFeed Editable Grid Column Configuration Component (a!gridLayoutColumnConfig)
Editable Grid Column Configuration Component
SAIL Design System guidance available for Grids

Grids should help your users take action and make decisions. Check out the grids design guidance page to learn how to display your data in a structured, easy-to-scan layout to help your users find what they need.

Function

a!gridLayoutColumnConfig( width, weight, showWhen )

Defines a column configuration for use in an Editable Grid.

Parameters

Name Keyword Types Description

Width

width

Text

Determines the column width. Valid values: "DISTRIBUTE" (default), "NARROW", "ICON".

Weight

weight

Number (Integer)

Determines how wide distributed columns are in relation to each other. Valid values: integers from 1 (default) to 10.

Visibility

showWhen

Boolean

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

Usage considerations

Using the editable grid's columnConfigurations parameter

  • The number of column configurations need not match the number of columns in the grid. They are matched with the columns by their position in the columnConfigurations array.

Examples

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

Narrow grid column

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
a!gridLayoutColumnConfig(
  width: "ICON"
)

Feature compatibility

The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Editable Grid Column Configuration Component.

Open in Github Built: Fri, Sep 29, 2023 (07:13:45 PM)

Editable Grid Column Configuration Component

FEEDBACK