Component: String Label (Indicators)

Author	Matrix TSL
Version	1.0 (Release)
Category	Indicators

String Label component

Allows a numeric label to be displayed on the user panel. Used for displaying the value of a variable during simulation runtime. Provides up to 5 customisable ranges to automatically alter the colour of the label based on the value.

Examples

No additional examples

Downloadable macro reference

This component does not contain any downloadable macros

Simulation macro reference

DisplayString

Displays a string value on the label.

Parameters

<- STRING Value

Integer value to display

This parameter may be returned back to the caller

Return value

This call does not return a value

SetBackgroundColour

Allows the user to manually specify the default colour of the background.

Parameters

LONG Colour

RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent

Return value

This call does not return a value

SetForegroundColour

Allows the user to manually specify the default colour of the foreground text.

Parameters

LONG Colour

RGB colour in the hexadecimal form 0xBBGGRR, -1 for Transparent

Return value

This call does not return a value

Property reference

Show Title

This property is of type True or false and can be referenced with the variable name ShowTitle.

Decides if the title is shown on the panel.

Title Text

This property is of type Line of text and can be referenced with the variable name Title.

Specifies the title displayed on the panel.

Title Scale

This property is of type Floating point and can be referenced with the variable name TitleScale.

Specifies the size of the title on the panel, default 1.2

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgColTitle.

Specifies the foreground colour of the title text

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgColTitle.

Specifies the background colour of the title text

Label Scale

This property is of type Floating point and can be referenced with the variable name LabelScale.

Specifies the scale of the label text, default 1.0

Colour Values

This property is of type Fixed list of ints and can be referenced with the variable name Range.

Allows ranges to be specified to automatically format the foreground and background colours based on the numeric value

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol.

The label foreground Text colour

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol.

The label background Surrounding colour

Value

This property is of type Line of text and can be referenced with the variable name Value1.

No additional information

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol1.

The label foreground Text colour when in the specified range

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol1.

The label background highlight colour when in the specified range

Value

This property is of type Line of text and can be referenced with the variable name Value2.

No additional information

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol2.

The label foreground Text colour when in the specified range

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol2.

The label background highlight colour when in the specified range

Value

This property is of type Line of text and can be referenced with the variable name Value3.

No additional information

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol3.

The label foreground Text colour when in the specified range

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol3.

The label background highlight colour when in the specified range

Value

This property is of type Line of text and can be referenced with the variable name Value4.

No additional information

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol4.

The label foreground Text colour when in the specified range

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol4.

The label background highlight colour when in the specified range

Value

This property is of type Line of text and can be referenced with the variable name Value5.

No additional information

Foreground Colour

This property is of type Color picker with transparency and can be referenced with the variable name FgCol5.

The label foreground Text colour when in the specified range

Background Colour

This property is of type Color picker with transparency and can be referenced with the variable name BgCol5.

The label background highlight colour when in the specified range