Holds an array of Text or Image columns that configure and define the data or links to display for each column in the grid. Configured using a!gridTextColumn(label, field, data, alignment) or a!gridImageColumn(label, field, data, alignment).
Text or Integer Array
Accepts an array of text or integers that are used to determine which rows are selected.
Holds the paging and sorting configurations for the grid as well as which rows in the grid should be selected. When defined with the variable configured in Save Paging and Selection To, it allows users to change the sort column, view another grid page, or select and deselect rows. When the type is GridSelection, checkboxes appear for each row if selection is enabled. When the type is PagingInfo, no checkboxes appear.
Save Paging and Selection To
One or more variables that are updated with the paging or grid selection configuration when the user pages, sorts, or changes the grid's selections. Use a!save() to save a modified or alternative value to a variable.
Determines if the rows in the grid are selectable. Default is false.
Determines if a selection is required to submit the form. Default is false.
Custom message to be displayed when a selection is required and not provided.
Determines if the user is prevented from changing which rows are selected. Default is false.
Validation errors to be displayed below the field when the value is not null.
When present, this field is only validated when a button in the same validation group is clicked.
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.
If the Columns argument is null or empty, an error occurs when the SAIL is opened.
Each column’s width is determined by the length of the longest value in that column. If the sum of those widths surpasses the allotted space, a horizontal scroll bar displays for users to view the remaining data. The allotted space for the grid depends on its placement in a one-column layout or two-column layout within the SAIL.
The order of items in the array for Columns determines the order of the columns. The order of items in the Data array in each Columns item determines the default order of the data.
Spaces and line breaks are supported within a column’s Label and Data values.
A column’s Data values may come from Appian engines, relational databases, or other data sources.
If the Data value for a column is empty or null, the grid still renders the column with just the label.
If the length of any Data array in the Columns argument is null or less than the Total Count argument, an error occurs when the SAIL is opened.
If the Field argument for a column is null, it does not display a sort indicator even if the data is sorted by that column.
Each time a user interacts with the grid, it outputs a value of type PagingInfo that is then saved in your Save Paging and Selection To parameter which is used to refresh and render the grid accordingly.
If you pass a null value to the value parameter, an error occurs when the SAIL is opened.
If the batchSize value in Paging and Selection Value is less than the length of any Data array in columns, an error occurs when the SAIL interface is opened.
If the startIndex value in Paging and Selection Value is greater than the totalCount argument, an error occurs when the SAIL interface is opened.
Passing a local variable with the load() function to the value parameter and passing the same local variable to the Save Paging and Selection To parameter allows for re-evaluation of the expression when users click a column to change the sorting or navigate to another page of the grid.
Paging and sorting do not function when this component is used offline. Images in the grid do not render when offline.
Paging controls are not displayed when the grid has 5 or fewer rows and all rows are on one page.
Paging controls to jump to the first or last page are not displayed when a grid has 100 or fewer total items. This reduces clutter on smaller grids.
Copy and paste an example to the Interface Designer to see it displayed.
Grid Showing Static Columns
Displays the following:
Single-Column Grid with Paging/Sorting
Displays the following:
NOTE: If you sort or page through this example, you’ll notice the instructions change. We’ve configured this value as local!pagingInfo to show how the pagingInfo value changes each time the expression is re-evaluated.