Radial Gauge

A radial gauge is a radial display in which a value can be displayed by filling in a bar. A start and end value can be defined for this bar. The attribute 'Editable' can be used to display a slider through which the operator can change the linked value.

Attributes

Category: Colors

Name

Description

ProgressBackgroundColor

Definition of the background color of the bar

ProgressForegroundColor

Definition of the bar color

GaugeBackground

Definition of the color of the round background

ValueColor

Definition of the text color of the display of the current value

LabelColor

Definition of the text color of the scaling values

UnitColor

Definition of the unit color

TickColor

Definition of the scaling color

KnobColor

Definition of the fill color of the slider

KnobArrowsColor

Definition of the outline and arrow color of the slider

BackgroundColor

Definition of the background color

BorderColor

Definition of the border color of the control

Category: Layout

Name

Description

StartPosition

Definition of the start angle of the display

EndPosition

Definition of the end angle of the display

Left

Definition of the distance from the left side to the left side of the surrounding control

LeftUnit

Definition of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Top

Definition of the distance from the top side to the top side of the surrounding control

TopUnit

Selection of the unit of the distance to the top side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Right

Definition of the distance from the right side to the right side of the surrounding control

RightUnit

Selection of the unit of the distance to the right side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Bottom

Definition of the distance from the bottom side to the bottom side of the surrounding control

BottomUnit

Selection of the unit of the distance to the bottom side of the surrounding control:

  • Pixels for absolute positioning
  • Percent for relative positioning

Width

Definition of the external width of the control

WidthUnit

Selection of the unit of the width:

  • Pixels for an absolute width
  • Percent for a relative width

Height

Definition of the external height of the control

HeightUnit

Selection of the unit of the height:

  • Pixels for an absolute height
  • Percent for a relative height

MaxWidth

Definition of the maximum width if the control size is defined as dynamic

MaxWidthUnit

Selection of the unit of the maximum width:

  • Pixels for an absolute value
  • Percent for a relative value

MinWidth

Definition of the minimum width if the control size is defined as dynamic

MinWidthUnit

Selection of the unit of the minimum width:

  • Pixels for an absolute value
  • Percent for a relative value

MaxHeight

Definition of the maximum height if the control size is defined as dynamic

MaxHeightUnit

Selection of the unit of the maximum height:

  • Pixels for an absolute value
  • Percent for a relative value

MinHeight

Definition of the minimum height if the control size is defined as dynamic

MinHeightUnit

Selection of the unit of the minimum height:

  • Pixels for an absolute value
  • Percent for a relative value

RenderedLeft

Calculated distance in pixels from the left side to the left side of the surrounding control

RenderedTop

Calculated distance in pixels from the top side to the top side of the surrounding control

RenderedRight

Calculated distance in pixels from the right side to the right side of the surrounding control

RenderedBottom

Calculated distance in pixels from the bottom side to the bottom side of the surrounding control

RenderedWidth

Calculated width of the control in pixels

RenderedHeight

Calculated height of the control in pixels

GridRowIndex

Definition of the row of a grid in which the control is to be displayed

GridColumnIndex

Definition of the column of a grid in which the control is to be displayed

Opacity

Definition of the transparency of the entire control

Visibility

Selection of the visibility of a control:

  • Visible: Control is visible
  • Hidden: Control is invisible, but is drawn – controls behind it cannot be operated
  • Collapsed: Control is invisible and is not drawn – controls behind it can be operated

ZIndex

Definition of the position on the Z-axis

Transform

Definition of a transformation of a control:

  • Translate: Translate in X-, Y-, Z-direction
  • Rotate: Rotate by an angle
  • Scale: Zoom by a factor
  • Skew: Sides shown skewed by an angle
  • Origin: Set the origin of the transformation relative to the position of the control
  • Perspective: Set the perspective of the transformations of all child elements

BoxShadow

Definition of a shadow

WidthMode

Selection of the method of calculating the width:

  • Value: The width is defined by the width entered.
  • Parent: The width is defined by the distance to the left and right side of the parent element. The "Width" attribute is ignored in all calculations!

HeightMode

Selection of the method of calculating the height:

  • Value: The height is defined by the height entered.
  • Parent: The height is defined by the distance to the top and bottom side of the parent element. The "Height" attribute is ignored in all calculations!

Category: Common

Name

Description

Value

Definition of the value to be displayed

Editable

Selecting whether the slider should be displayed and therefore whether the linear gauge is editable

BaseAnimationTime

Definition of the base animation time in milliseconds. It describes the time of the animation from minimum to maximum value.

IsEnabled

Selection of whether a control should be activated

Id

Definition of the name of the control

Type

Type name of the control

ClassNames

Definition of control classes

IsAttached

If a control is logically assigned in the DOM.

Tooltip

Definition of the tooltip for the control

Category: Border

Name

Description

BorderRadius

Definition of the radius of the four corners to round them off

BorderStyle

Selection of the border style of the four sides of the control

BorderWidth

Definition of the border width of the four sides of the control

Category: Background Image

Name

Description

BackgroundImage

Definition of an image that is located above the background color

BackgroundImageHeight

Definition of the height of the background image

BackgroundImageHeightUnit

Selection of the unit of the height of the background image:

  • Pixels for an absolute height
  • Percent for a relative height

BackgroundImageWidth

Definition of the width of the background image

BackgroundImageWidthUnit

Selection of the unit of the width of the background image:

  • Pixels for an absolute width
  • Percent for a relative width

BackgroundImagePadding

Definition of an additional distance between the border of the control and background image for the four sides

BackgroundImageVerticalAlignment

Definition of the vertical alignment of the background image within the control

BackgroundImageHorizontalAlignment

Definition of the horizontal alignment of the background image within the control

Category: Value

Name

Description

MinValue

Defines the smallest value that the control element should graphically display

MaxValue

Defines the largest value that the control element should graphically display

Step

Definition of the increment for changing the value via the slider

Range

Definition of the value range of the color scales

ShowValueText

Selecting whether the current value is to be displayed

StartFromZero

Selecting whether the minimum value is to be zero irrespective of the 'Minimum Value' attribute.

ValueFontFamily

Definition of the font using the name of the font family or the keyword

ValueFontSize

Definition of the font size

ValueFontSizeUnit

Selecting the font size unit:

  • Pixels for an absolute size
  • Percent for a relative size

ValueFontStyle

Selecting the font style:

  • Normal
  • Italic: italic
  • Oblique: slanted

ValueFontWeight

Selecting the font weight:

  • Normal
  • Bold: bold

ValueFormat

Definition of a formatting function for the value

ClickAnywhereToEdit

Selecting whether the value can be changed by clicking anywhere in the control

Category: Labels

Name

Description

ShowLabels

Selecting whether the scaling values are to be displayed

LabelPosition

Selecting the position of the scaling to the bar:

  • Inside
  • Outside

LabelRange

Definition of the jump distance between the individual scaling values

LabelFormat

Definition of a formatting function for the scaling

LabelFontFamily

Definition of the font using the name of the font family or the keyword

LabelFontSize

Definition of the font size of the scaling

LabelFontSizeUnit

Selecting the unit:

  • Pixels for an absolute size
  • Percent for a relative size

LabelFontStyle

Selecting the font style of the scaling:

  • Normal
  • Italic: italic
  • Oblique: slanted

LabelFontWeight

Selecting the font weight of the scaling:

  • Normal
  • Bold: bold

Category: Ticks

Name

Description

ShowTicks

Selecting whether the scaling subdivision is to be displayed

TickDefinition

Definition of scale divisions

SubTickPosition

Selecting the position of the auxiliary scaling to the bar:

  • Inside
  • Outside

Category: Unit

Name

Description

Unit

Definition of the unit or description of the value

UnitFontFamily

Definition of the font using the name of the font family or the keyword

UnitFontSize

Definition of the font size of the unit

UnitFontSizeUnit

Selecting the font size unit:

  • Pixels for an absolute size
  • Percent for a relative size

UnitFontStyle

Selecting the font style of the label:

  • Normal
  • Italic: italic
  • Oblique: slanted

UnitFontWeight

Selecting the font weight:

  • Normal
  • Bold: bold

Events

Category: Control

Name

Description

onValueChanged

The value has been changed.

Category: Framework

Name

Description

onAttached

The control was added to the display.

onDetached

The control was removed from the display.

onInitialized

The control was initialized.

onDestroyed

The control was destroyed.

onMoved

The control was moved in relation to the browser window.

onResized

The size of the control was changed.

Category: Operator

Name

Description

onUserInteractionFinished

The user has finished the interaction with the control.

onPressed

A mouse click was executed or a touch screen was briefly touched.

onMouseClick

The left mouse button was clicked over the control and released.

onMouseDoubleClick

The left mouse button was clicked twice over the control and released.

onMouseRightClick

The right mouse button was clicked over the control and released.

onMouseDown

A mouse button was pressed down over the control.

onMouseEnter

The mouse pointer was moved over the control.

onMouseLeave

The mouse pointer has left the control.

onMouseUp

A mouse button was released over the control.

onMouseDownLeft

The left mouse button was pressed down over the control.

onMouseDownRight

The right mouse button was pressed down over the control.

onMouseMove

The mouse was moved over the control.

onMouseOver

The mouse pointer was moved over the control or one of its children.

onMouseOut

The mouse pointer has left the control or one of its child controls.

onMouseUpLeft

The left mouse button was released over the control.

onMouseUpRight

The right mouse button was released over the control.

onMouseWheel

The mouse wheel was moved over the control.

onTouchStart

A finger/stylus was placed against a touch screen.

onTouchMove

A finger/stylus was moved on a touch screen.

onTouchEnd

A finger/stylus was lifted off a touch screen.

onTouchCancel

An interaction with a touch screen was aborted.

Access rights

Name

Description

observe

Determines whether the control is generally observable.

operate

Determines whether the control is generally operable.

Inheritance hierarchy

Control

    Radial Gauge

NuGet package: Beckhoff.TwinCAT.HMI.Controls

Radial Gauge 1:

NuGet packages are available from version 1.12.

Radial Gauge 2:

Available from 1.8

See also

API reference for this control