Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Operations Management Interface

Configure GraphicRepeaterApp properties

  • Last UpdatedJul 16, 2024
  • 8 minute read

GraphicRepeaterApp properties can be shown in the Layout or ViewApp editors by placing the GraphicRepeaterApp on a layout pane. After selecting the app on a pane, its properties appear on the Properties page by functional groups. The following figure shows the default property values after initially opening the app.

Embedded Image (65% Scaling) (LIVE)

Property value validation checking

As you enter values for properties, the GraphicRepeaterApp validates the input of some properties. If an invalid input value is detected, a red rectangle appears around the data entry field.

GRA_ErrorRedRectangle

Placing your mouse directly over the data entry field containing the invalid data shows a tooltip with more information about the invalid data.

Embedded Image (65% Scaling) (LIVE)

The table following the property configuration procedure includes a list of property value requirements for those properties whose input is validated by the GraphicRepeaterApp.

Further error checking occurs when the ViewApp containing a GraphicRepeaterApp is deployed and starts running. See Validity checking during runtime.

To configure GraphicRepeaterApp properties

  1. Open the Layout or ViewApp Editor and select the Toolbox tab.

  2. Open the folder in the Toolbox where the GraphicRepeaterApp was placed when it was imported.

  3. Select the GraphicRepeaterApp.

  4. Drag and drop the GraphicRepeaterApp thumbnail onto a layout pane.

  5. Select the GraphicRepeaterApp thumbnail and select the Properties tab.

    The Properties tab shows the properties of the GraphicRepeaterApp.

    The following table describes each property.

  6. Assign values to properties and save your changes.

    Note: The GraphicRepeaterApp can be shown in a preview session to quickly assess your property changes without deploying the ViewApp. A preview session launches immediately and runs the ViewApp containing the GraphicRepeaterApp in a separate window.

Properties

Descriptions

Graphic Name

Specifies the graphic to repeat by the app. If It is a graphic associated with an object, specify the name as ObjectName.GraphicName.

Embedded graphics are supported. In the following example, the basesymbol specified from the Graphic Name property contains embedsymbol1. The cpint custom property of the embedded graphic is specified as a custom property in the form embedded_graphic_name.custom_property

The number of repeatable graphics shown during runtime is based on the following formula:

# graphics = # data groups / # custom properties

Property Value Requirements

  • A single graphic name must be assigned to the Graphic Name property. The Graphic Name property cannot be left blank.

  • Graphic name must contain at least one alphanumeric character or special characters $, #, _, or a period (.).

  • Graphic name cannot start with a dollar sign ($) or period (.)

  • Graphic name cannot end with a period (.) or contain more than one period in the name.

Background Name

Specifies the name of an optional graphic to appear behind the repeating graphic list during runtime. The background graphic provides header and footer information for the app.

A background graphic stretches to fit the full width and height of the pane in which the GraphicRepeaterApp has been placed. Use the List Margin property to adjust the offset between the graphic list and the background graphic.

For more information about specifying a background for the GraphicRepeaterApp, see Details of background properties.

Property Value Requirements

Same as the Graphic Name property.

Custom Properties

Specifies one or more custom properties that belong to the graphic specified by the Graphic Name property.

Multiple custom properties must be specified in a comma delimited list.

cp1,cp2,cp3

Note: Regardless of the regional setting of the computer, a comma is used as the data delimiter.

For more information about the rules of comma delimited data, see Details of comma-delimited data.

Custom properties specified by the Custom Properties property must match the corresponding Data values one to one in the list.

Property Value Requirements

  • At least one custom property must be specified and the property cannot be left blank.

  • Custom property names must contain at least one alphanumeric character or special characters $, #, _, or a period (.).

  • Number of specified custom properties cannot exceed 20.

Data

A list of data references matched to custom properties in a comma delimited list that maps one to one with the custom properties list.

Important: If there is a mismatch between custom properties and data during runtime, the app will discard unmatched data points and an error message appears in the logger.

A data value can be a reference or a constant and can be modified during runtime. For more information about the Data property, see Details of the Data property.

Client and layout scripts can be used to set data references for graphic custom properties.

Property Value Requirements

  • Data values must be provided

    For more information about the number of data points that can be shown by the GraphicRepeaterApp based on the value of the Live Sorting property, see Details of the Live Sorting property.

  • Passing data to custom properties using relative references (eg: Me.references) is not supported.

Filter Top N

Filters the list of repeatable graphics shown during runtime to a specified number (N). The default is 0 to show all graphics.

Property Value Requirements

  • N value must be an integer.

  • The Filter Top N value must be less than or equal to the number of data points. If the Filter Top N value is greater than the number data points, then the Filter Top N value is ignored and all data points are shown without filtering.

Sort By

Specifies the name of a custom property whose current value is used to sort graphics during runtime based on the configured sort order.

For more information about sorting data, see Details of sorting properties.

Property Value Requirements

Entered custom property name must match one of the graphic custom properties specified for the Custom Properties property.

Sort Order

Identifies the repeating graphics sort order: Ascending or Descending by custom property value. The default sort order is Descending.

Live Sorting

Boolean property to enable or disable graphics sorting at runtime. The default is false to disable sorting.

The Live Sorting property can be modifed during runtime to enable or disable graphic sorting.

For more information, see Details of the Live Sorting property.

View Mode

Determines the organization of repeating graphics within a layout pane.

ListContent

Graphic items are shown in the GraphicRepeaterApp as a continuous sequential list. Based on the specified value of the Fill Style property, the sequential list is arranged in vertical or horizontal order. The default view mode.

When View Mode property is set to ListContent, the GraphicRepeaterApp includes scroll bars to view graphics that extend beyond the bottom or right border of the pane.

WrapContent

Repeating graphics are listed in the fill direction until a graphic does not fit within the border of the pane. The graphic then wraps to the next column or row within the pane. Scroll bars appear when the graphic item list extends beyond the pane borders.

When View Mode is set to WrapContent, repeating graphics appear on the next row or next column based on whether the Fill Style property value is Horizontal or Vertical.

Fill Style

Options to set vertical or horizontal fill order of repeating graphics.

  • Horizontal fill order is left to right within the pane.

  • Vertical fill order is top to bottom within the pane. Vertical is the default.

    For more information about graphic size based on the selected Fill Style options, see Details of the Fill style property.

List Margin

Specifies the pixel offset between a background graphic and the list of repeating graphics. The offset is specified as blank space padding on the left, top, right, and bottom of the reference repeating graphic.

List Margin values are specified in a comma delimited ordinal list of integers as Left,Top,Right,Bottom.

0,0,0,0 is the default, which does not include a margin offset between the repeating graphics and background graphic.

Graphics Padding

Number of pixels as blank space padding on the left, right, top, and bottom of a graphic shown in the GraphicRepeaterApp.

Padding values are specified in a comma delimited ordinal list of integers as Left,Top,Right,Bottom.

0,0,0,0 is the default, which does not provide any padding.

For more information, See Details of the Padding property.

Display Columns

Number of columns containing repeating graphics during runtime. Column numbers are specified as an integer and 0 is the default value.

The GraphicRepeaterApp includes a horizontal scroll bar to show columns outside of the limit set by the Display Columns property.

Important: If the product of the Display Columns and Display Rows values exceed 50, an error occurs at runtime.

For more information, see Details of the DisplayColumns property.

Property Value Requirements

  • Display Columns value must be an integer.

  • Display Columns value cannot exceed 50.

Display Rows

Number of rows containing repeating graphics shown during runtime. Row numbers are specified as integers and 0 is the default value.

The GraphicRepeaterApp includes a vertical scroll bar to show rows outside of the limit set by the Display Rows property.

Important: If the product of the Display Columns and Display Rows values exceed 50, an error occurs at runtime.

For more information, see Details of the Display Rows property.

Property Value Requirements

  • Display Rows value must be an integer.

  • Display Rows value cannot exceed 50.

Background

Optional background color that appears in the entire pane area in which the GraphicRepeaterApp has been placed. No color is the default background.

Select the Background entry field to show a color picker control to select a background color.

The GraphicRepeaterApp includes two read-only properties that show the current minimum and maximum values of the custom property associated with the Sort By property. These two properties can be used only in scripts.

Important: In scripts, you must be careful in typecasting to the appropriate datatype and include checking for null values.

MaxValue

Gets the current maximum value of the Sort-By custom property from the set of repeatable graphics.

This property can be accessed only by script.

Example

MyViewApp.VAN.Max = MyContent.GraphicRepeaterControl1.MaxValue;

MinValue

Gets the current minimum value of the Sort-By custom property from the set of repeatable graphics.

This property can be accessed only by script.

Example

MyViewApp.VAN.Min = MyContent.GraphicRepeaterControl1.MinValue;

TitleResults for “How to create a CRG?”Also Available in