Dynamic Layout Properties - General tab

Dynamic Layout Properties — General tab

Click the Gear icon in the dynamic layout header to display the Dynamic Layout Properties panel and select the General tab.

Field Description
Layout format Select a layout format for the dynamic layout:
  • Default
  • Stacked
  • Inline
  • Inline grid double
  • Inline grid triple

Select Other to select from additional dynamic layout formats defined in the skin.

You can create and modify dynamic layout formats in the skin. Skin form — Components tab — Layouts — Dynamic Layouts.

Container format Select a format for the container.

Select Other to select from custom container formats defined in the skin. In the field that appears, specify the custom format.

Refresh Condition Optional. Enter a simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators.

As a best practice, use the Condition Builder to edit expressions, or to trigger a refresh based on a property change or the addition or deletion of a row or column in a repeating layout. The editor also enables you to specify a pre-activity or data transform. Click the Gear icon to open the tool. See Using the Condition Builder to configure dynamic form actions.

Visibility

To control the visibility of the container, select one of the following:

  • Always : always visible
  • Condition (expression) : the region is visible under the specified condition. In the field that displays, select a condition or click the Gear icon to open the Condition Builder. You can define a simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.
  • Condition (when) : the region is visible under the specified condition. In the field that displays, select a when rule. Click the Open icon to create a new when condition or review an existing when condition.
Note: If this section is to become part of navigation in a composite portal, you can make the header visible only when a specific space is the current space. Enter an expression here similar to the following:
pyCurrentSpace=="ASpaceName"
Then select the Run visibility condition on client check box.
Pagination Appears in repeating dynamic layouts only.
Pagination format
Optional. If the data results comprise more than a single page, you may want to specify a paging format:
None No paging (default).
Progressively load on user action Retrieves a segment, known as a page, from the total data set on the clipboard. You can specify the number of rows per page and select a page navigation control format.

Additional data displays as the user clicks on the page navigation control, providing the user with access to the full list.

Note: This option works only when the underlying harness is configured to use client-side template UI. If the harness is not configured to use client-side template, the pagination format falls back to the Progressively load on user action option.
Progressively load on scroll Limits the number of rows initially loaded to render the page more quickly. Remaining items are loaded as-needed, as the user scrolls through the list.

Enables users to access the entire data set by scrolling.

Note: This option works only when the underlying harness is not configured to use client-side template UI. If the harness is configured to use client-side template, the pagination format falls back to the None option.
Page size (number of rows) Appears if you select a Pagination format other than None . Select the items rows per page (10 is the default). To specify a custom value, select Other and enter a positive integer in the empty field.
Header type Choose the format to be used to present this header:
  • Bar — A horizontal bar that is always present. The section appears as a single horizontal strip; all labels and values visible on the strip.
  • Collapsible — A horizontal bar marked with an icons that mark an area below the bar that users can expand or collapse.
  • Fieldset — Provides no header area, but a border around the contents of the layout with a single text label. (This produces HTML FieldSet and Legend elements.)
Expand when Appears when the Header type is Collapsible. Specify the When condition that must be met to expand the content.
Expanded on load Appears when the Header type is Collapsible.

Select to display the container expanded, rather than collapsed, on load.
Defer load contents Optional. Choose this option to delay loading at run time of the section content until the user clicks the header. Deferring enables users to start using other parts of the page rather than waiting for this section to load.

To enable users to take actions, such as submit, on a work item while other content is still being loaded, configure sections to use defer loaded asynchronous declare pages. See Pega Community article How to configure non-blocking UI using Asynchronous Declare Pages (ADP).

Specify a pre-loading activity Optional. If the Header type is Collapsible, you can specify an activity to be run, prior to loading, when the container is expanded by a click. This activity can compute property values and other aspects of the expanded container. As a best practice, create a defer loaded wrapper section with the retrieval activity (instead of having multiple defer loaded sections with wrapper activities.)
Tour ID

Optional: Provide an ID for use in a guided tour. Use a combination of numbers, letters, and underscores. Pega Platform uses the Tour ID when it finds an anchor button during a tour stop anchor point.

Test ID

Optional: If authorized, you can provide a unique Test ID to better support automated testing of your application.

When creating a control that supports you can use a combination of numbers, letters, and underscores, or click the Generate ID button to create a unique ID. The attribute data-test-id is then generated for the selected element.

After the test ID has been generated, you can view your Test ID in HTML or display it in the Live UI panel. You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

The Test ID is available to access groups that include the PegaRULES:TestID privilege. To disable Test ID, remove the PegaRULES:TestID from the access group.

Role Type Specify a WAI-ARIA role type for the dynamic layout. The WAI-ARIA role enables accessibility by communicating the role type and value to an assistive technology.
  • Landmark
  • Document Structure
  • Component/Widget
Value The Value appears when a WAI-ARIA role type is selected. The specific value options are dependent on the Role Type selected.
Descriptors Text entered in the Descriptor field appears in the auto-generated HTML as the ARIA label and can be read by an assistive technology.