User Tools

Site Tools


mistudio:design_editor:basic_layout:indicators:annunciator

Annunciator

com.ergotech.vib.graphics.Annunciator

Image Examples

Annunciator in the graphics palette Annunciator graphic example
Annunciator in the graphics palette. Annunciator graphic example.

Overview

The Annunciator graphic is a Basic Layout indicator used to display formatted numbers, strings, status text, or alarm-style messages.

Annunciator is an Active Graphic and is based on the Box graphic. It can display text inside a box-style area with configurable fill color, text color, number formatting, and label alignment.

Annunciator shares general Active Graphic behavior. See Active Graphic for shared visibility, quality, and runtime display behavior.

Common Uses

  • Displaying status text
  • Displaying formatted numeric values
  • Showing alarm or warning messages
  • Creating dashboard status boxes
  • Displaying multi-line text
  • Showing text or values from a data source

Input Behavior

Annunciator accepts any value object.

The input value can be displayed as formatted text or a formatted number, depending on the value and number format configuration.

Multiple lines of text can be displayed if a paragraph tag or carriage return character is included between lines.

Output Behavior

Annunciator is primarily used as a display graphic.

It does not function as a user input control.

Annunciator-Specific Behavior

Annunciator displays values inside a box-style indicator area.

Annunciator-specific settings may include:

  • Color Action Controls whether incoming color is used for nothing, the fill area, or the text label.
  • Bezel Sets the annunciator border or bezel style.
  • Font Controls the font used for displayed text.
  • Text Color Sets the color used for displayed text.
  • Number Format Controls how numeric values are displayed.
  • Label Horizontal Alignment Controls whether text is aligned left, right, or centered.
  • Label Vertical Alignment Controls whether text is aligned top, bottom, or centered.
  • Fill Color Sets the background color of the Annunciator.

Logic Ports

In the Logic Editor, Annunciator may include:

  • valueInput

The valueInput port is used to update the displayed Annunciator value.

Notes

Use Annunciator when text, numbers, status messages, or alarm-style information need to be displayed inside a box-style indicator.

For related box-style behavior, see Box.

For other indicator graphics, see Indicators.

For shared Active Graphic behavior, see Active Graphic.

mistudio/design_editor/basic_layout/indicators/annunciator.txt · Last modified: by tputman

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki