Skip to end of metadata
Go to start of metadata


General

Component Palette Icon:



Description

The Numeric Entry Field is similar to the standard Text Field, except that it is specialized for use with numbers. When the 'enabled' property is set to true, it allows users to alter the value on the component. There are three different modes for how users can edit the value in the component: direct, protected or by clicking an edit button. To change the value, click once in the field for 'direct' mode, double click for 'protected' mode, and click on the Edit icon for the 'button' mode. When done, press enter or leave the field, and the field becomes editable again. When the 'enabled' property is false, the field is not editable even when it receives input focus.

This feature is new in Ignition version 8.1.2
Click here to check out the other new features

The Numeric Entry Field component has three pre-configured variants:

  • Direct -   Default design of the field.
  • Protect - Requires a double-click or long-press to enter edit mode.
  • Button - Clicking the button brings up a popup window, allowing the user to edit the value from the popup, or cancel the edit.
Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

NameDescriptionProperty Type
valueValue as number or numeric string to display.value: numeric
format

The formatting string to be applied to the input value. Options are currency, number, integer, four decimal precision, percent, scientific, accounting, financial, currency, currency (rounded), duration, abbreviation, or ordinal. A list of format specifiers can be found here.

This feature is new in Ignition version 8.1.2
Click here to check out the other new features

The Numeric Entry Field supports locale-specific formatting, allowing changes to the session's locale to update how numbers are formatted on the Numeric Entry Field. Note that the localization conversion occurs automatically after the initial format specifiers are applied.

value: string
mode

Determines how users will edit the value in the component. The following modes are available:

ModeDescription
DirectRequires no special action to enter edit mode simply click in the field.
ProtectedRequires a double-click or long-press to enter edit mode.
Button

Places an Edit icon next to the Numeric Entry Field. Clicking the button brings up a popup window, allowing the user to edit the value from the popup, or cancel the edit.

The value in the component may only be edited via the popup.

value: string
alignAligns the input value right or left.value: boolean
inputBounds

Max and min bounds configuration.

 Click to see the inputBounds properties
NameDescriptionProperty Type
maximumThe max allowable value.value: numeric
minimumThe min allowable value.value: numeric
invalidStyleSets an invalid style when the min or max values are out of bounds for this component. Modify the invalidStyle using the style properties. Full menu of style options is available. You can also specify a style class as an invalid style.object
object
placeholderText to be displayed when value is empty.value: string
tooltipTextMousing over this button will display a tooltip with this text, if present.value: string
enabled

Indicates if user should be allowed to alter the value.

Note: If the component is disabled, scripts can still run on the component. For example, if you add a script action to the onClick event, the script will fire when the user clicks on the Numeric Entry Field.

value: boolean
containerStyle

This feature is new in Ignition version 8.1.2
Click here to check out the other new features

Sets a style for the outer area of the component. Ideal for adding padding between the outer area and the numeric display/input. 

object
style

Sets a style for this component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

Perspective Component Events
The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

Examples
Example 1

This example shows the component set to "button" mode, providing a button to click on when entering a new value. 

PropertyValue
props.value45.678
props.format#0.0
props.modebutton
props.aligncenter
props.placeholdersetpoint
Example 2

This examples demonstrates the placeholder property, showing a default entry in cases where the value is null. 

PropertyValue
props.valuenull
props.format#0.0
props.modebutton
props.aligncenter
props.placeholdersetpoint
Example 3

This example demonstrates the format property, allowing custom formatting to be applied to the value in the component. 

PropertyValue
props.value0.2345
props.format0.0#%
props.modedirect
props.alignright
props.placeholdersetpoint


  • No labels