Instance Property

usesSignificantDigits

A Boolean value indicating whether the formatter uses minimum and maximum significant digits when formatting numbers.

Declaration

var usesSignificantDigits: Bool { get set }

Discussion

The NumberFormatter class has two ways of determining how many digits to represent: using integer and fraction digits and using significant digits.

When this property is set to false, numbers are formatted according to whether you want them formatted as fractions or as integers. For more information, see Configuring Integer and Fraction Digits. This property is false by default.

Set this property to true to format numbers according to the significant digits configuration specified by the minimumSignificantDigits and maximumSignificantDigits properties. By default, the minimum number of significant digits is 1, and the maximum number of significant digits is 6.

The following code demonstrates the effect of configuring usesSignificantDigits when formatting various numbers:

var numberFormatter = NumberFormatter()

// Using significant digits
numberFormatter.usesSignificantDigits = true
numberFormatter.string(from: 12345678) // 12345700
numberFormatter.string(from: 1234.5678) // 1234.57
numberFormatter.string(from: 100.2345678) // 100.235
numberFormatter.string(from: 1.230000) // 1.23
numberFormatter.string(from: 0.00000123) // 0.00000123

// Using integer and fraction digits
numberFormatter.usesSignificantDigits = false
numberFormatter.string(from: 12345678) // 12345678
numberFormatter.string(from: 1234.5678) // 1235
numberFormatter.string(from: 100.2345678) // 100
numberFormatter.string(from: 1.230000) // 1
numberFormatter.string(from: 0.00000123) // 0

See Also

Configuring Significant Digits

var minimumSignificantDigits: Int

The minimum number of significant digits for the number formatter.

var maximumSignificantDigits: Int

The maximum number of significant digits for the number formatter.