Skip to main content
Version: 7.9

Numeric Label

Component Palette Icon

This component is a specialized label designed to display a number. It can include units, and has an integrated number format string. By default the number is displayed bold and the units are not. This can be customized, see the Prefix and Suffix expert properties. This label's text is constructed as follows:

Prefix + numberFormat (Value, Pattern) + Suffix + Units

It is important to note that you could customize the standard Label component using custom properties and bindings to mimic this component exactly. If this component doesn't do something that you need, you can make your own numeric label and use it everywhere in your project.


NameDescriptionProperty TypeScriptingCategory
AntialiasDraw with antialias on? Makes text smoother.boolean.antialiasAppearance
Background ColorThe background color of the component.Color.backgroundAppearance
BorderThe border surrounding this component. NOTE that the border is unaffected by rotation.Border.borderCommon
CursorThe mouse cursor to use when hovering over this
Data QualityThe data quality code for any tag bindings on this
Disabled Image PathThe relative path of the image to be displayed when this component is not enabled.String.disabledPathAppearance
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
Fill BackgroundIf true, the label's background color will be drawn. If false, it will have a transparent background.boolean.fillBackgroundAppearance
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component.Color.foregroundAppearance
Horizontal AlignmentDetermines the alignment of the label's contents along the X
Horizontal Text PositionDetermines the horizontal position of the label's text, relative to its
Icon-Text SpacingThe space (in pixels) between the icon (if any) and the text (if any).int.iconTextGapAppearance
Image PathThe relative path of the image.String.pathAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Number Format PatternThe number formatting string used to format the value.String.patternAppearance
PrefixA string that will be placed before the number.String.prefixData
RotationThe angle of rotation in
StylesContains the component's styles.Dataset.stylesAppearance
SuffixA string that will be placed after the number, and before the units.String.suffixData
TextFull text of the label including the units. (Read only. Usable in bindings and scripting.)String.textUncategorized
UnitsThe engineering units to display after the number.String.unitsData
ValueThe numeric value of this label.double.valueData
Vertical AlignmentDetermines the alignment of the label's contents along the Y
Vertical Text PositionDetermines the vertical position of the label's text, relative to its
VisibleIf disabled, the component will be hidden.boolean.visibleCommon


Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page



Numeric Label with Red Background and Percent Sign

Property NameValue
Background Color255,0,0