Contents

scale(_:)

Modifies the format style to use the specified scale.

Declaration

func scale(_ multiplicand: Double) -> IntegerFormatStyle<Value>

Parameters

  • multiplicand:

    The multiplicand to apply to the format style.

Return Value

An integer format style modified to use the specified scale.

Discussion

The following example creates a default IntegerFormatStyle for the en_US locale, and a second style that scales by a multiplicand of 0.001. It then applies each style to an array of integers. The formatting that the modified style applies expresses each value in terms of one-thousandths.

let defaultStyle = IntegerFormatStyle<Int>(locale: Locale(identifier: "en_US"))
let scaledStyle = defaultStyle.scale(0.001)
let nums = [100, 1000, 10000, 100000, 1000000]
let defaultNums = nums.map { defaultStyle.format($0) } // ["100", "1,000", "10,000", "100,000", "1,000,000"]
let scaledNums = nums.map { scaledStyle.format($0) } // ["0.1", "1", "10", "100", "1,000"]

See Also

Customizing style behavior