![]() | 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. |
FunctionCopy link to clipboard
a!gridRowLayout( contents, id, selectionDisabled, showWhen )
Displays a row of components within an editable grid.
ParametersCopy link to clipboard
Name | Keyword | Types | Description |
---|---|---|---|
Contents |
|
List of Variant |
Array of components to display in the grid cell. Supported components: Barcode, Checkboxes, Date, Date & Time, Dropdown, Decimal, Encrypted Text, File Upload, Image, Integer, Link, Multiple Dropdown, Paragraph, Pickers, Progress Bar, Radio Buttons, Rich Text Display, and Text. |
Identifier |
|
Any Type |
Value that uniquely identifies this row for selection. |
Selection disabled |
|
Boolean |
When selection is enabled, determines if the selection checkbox is disabled for this row. Default: false. |
Visibility |
|
Boolean |
Determines whether the row is displayed in the grid. When set to false, the row is hidden and is not evaluated. Default: true. |
Usage considerationsCopy link to clipboard
Component behaviorCopy link to clipboard
- Some interface component configurations do not take effect when placed in a grid cell. Refer to the grid layout section for details.
ExamplesCopy link to clipboard
To experiment with examples, copy and paste the expression into an interface object.
Grid rowCopy link to clipboard
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
5
6
7
a!gridRowLayout(
contents: {
a!textField(
value: "Cell"
)
}
)
Copy
Feature compatibilityCopy link to clipboard
The table below lists this 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. |
Related PatternsCopy link to clipboard
The following patterns include usage of the Editable Grid Row Component.
-
Add Validations to an Inline Editable Grid (Validation, Grids, Looping): Allows the user to change data directly in a grid, and validate a various entries.
-
Add, Edit, and Remove Data in an Inline Editable Grid (Grids, Looping): Allow the user to change data directly in an inline editable grid.
-
Display Multiple Files in a Grid (Document Management, Grids): Show a dynamic number of files in a grid and edit certain file attributes.
-
Expand/Collapse Rows in a Tree Grid (Hierarchical Data, Grids): Create a grid that shows hierarchical data and allows users to dynamically expand and collapse rows within the grid.
-
Track Adds and Deletes in Inline Editable Grid (Grids): In an inline editable grid, track the employees that are added for further processing in the next process steps.
-
Use Selection For Bulk Actions in an Inline Editable Grid (Grids): Allow the user to edit data inline in a grid one field at a time, or in bulk using selection.