format.adoc

format()

Important

Deprecated in 5.0. Please use [func-formatnumber] instead.

format(number, width, precision) => String

Formats a numeric value.

Table 1. Parameters

number	Number	The numeric value to format.
width	Number	Minimum number of characters. If the number of characters in the output value is less than the specified width, blanks are added to the left or the right of the values — depending on whether the width is negative (for left alignment) or positive (for right alignment) — until the minimum width is reached. The width specification never causes a value to be truncated.
precision	Number	The number of decimal places. Floating point value will be rounded accordingly.

Return

Formatted numeric value.

Example

format(3.7, 7, 2)		//	"   3.70"
format(3.7, -7, 2)		//	"3.70   "
format(5.7278, 1, 2)	//	"5.73"
format(5.7278, 1, 0)	//	"6"