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

AVEVA™ Work Tasks

Gauge

  • Last UpdatedJul 10, 2024
  • 4 minute read

Use Gauge control to display data in a gauge in your form.

Note: This control is not supported in AVEVA Work Tasks Pro.

Properties

The properties for the control are grouped under the following tabs:

Basic

Property

Description

Name

Name that identifies the control. This value is also used for the label of the control.

XML Node

XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.

  • Prefix with to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

    The default value is the value for the Name property without the spaces.

Note:
- If you use / to denote a parent which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.
- If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Tooltip

Message that appears when the pointer hovers over the control.

Appearance

Property

Description

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Label Position

Position of the label for the control.

  • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

  • Select Left to align the label to the left of the control.

  • Select Top to align the label to the top of the control.

  • Select Right to align the label to the right of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.
- For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

Label-Control Area

Area occupied by the label and the control in percentage.

  • Select Default to allow the system to set the label and the control areas.

  • Select Custom to specify the label area. The control area is automatically set based on the label area.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.
- This is applicable only when the Label Position is set to Left or Right.

Retain Space

Reserve or remove space when the control is hidden.

  • Select Yes to keep space when the control is hidden.

  • Select No to remove space when the control is hidden.

    The default value is No.

Alignment

Alignment of the control with respect to the form.

  • Select Left to align the control to the left of the form.

  • Select Right to align the control to the right of the form.

  • Select Center to align the control to the center of the form.

Scale Minimum Value

Minimum value displayed on the scale.

The default value is 0.

Scale Maximum Value

Maximum value displayed on the scale.

The default value is 100.

Scale Start Angle

The angle at which the scale starts.

The default value is -30 degrees.

Scale End Angle

The angle at which the scale ends.

The default value is 210 degrees.

Scale Major Unit

Value of major tick marks on the scale.

For example, if the Unit of Measurement is set to lb, and the Scale Major Unit is set to 50, then every major tick mark will denote a value of 50 lb.

The gauge is limited to a maximum of 100 major tick marks at runtime.Therefore, the value for the major unit must be set such that no more than 100 units would be rendered on the gauge.

The default value is 20.

Scale Minor Unit

Value of minor tick marks on the scale.

For example, if the Unit of Measurement is set to lb, and the Scale Minor Unit is set to 10, then every minor tick mark will denote a value of 10 lb.

The gauge is limited to a maximum of 200 minor tick marks at runtime.Therefore, the value for the minor unit must be set such that no more than 200 units would be rendered on the gauge.

The default value is 10.

Value Position

Position of the value for the control.

  • Select Top to align the label to the top of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Bottom.

Show Target Indicator

Show or hide the target indicator of the control.

  • Select Yes to show the target indicator of the control.

  • Select No to hide the target indicator of the control.

The default value is Yes.

Advanced

Property

Description

On Initialize

Run a script after the control has been initialized, but before it is rendered to the UI.

For more information, see scripting guidelines for On Initialize property.

Range Color

Run a script to apply a color to a range of values on the the gauge.

For more information, see scripting guidelines for Range Color property.

ID

Reference identification code for the control. This value is automatically generated and cannot be changed.

Target Value

Target value of the gauge. This is the value that the Target indicator points at.

The default value is 0.

Unit of Measurement

Unit of measurement for value of the control.

Decimal Places (Precision)

Decimal places for the value of the control.

The default value is 0.

Note: The Gauge control is not supported in mobile devices.

Scripts

For information about using scripts, see scripting guidelines for Gauge control.

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