numberFormat

This function is used by Ignition's Expression language.

Description

Returns a string version of the number argument, formatted as specified by the pattern string. This is commonly used to specify the number of decimal places to display, but can be used for more advanced formatting as well. The pattern string is a numeric format string, which may include any of these characters that instruct it how to format the number.

Refer to Data Type Formatting Reference.

Syntax

numberFormat(number, pattern)

• Parameters

  • Float number- The number to format.

  • String pattern - The format pattern.

• Results

  • String - The string representation of the number formatted according to the pattern provided.

Examples

Code Snippet

numberFormat(34.8, "#0.00'%'") //returns the string "34.80%"