Contents

sign(strategy:)

Modifies the format style to use the specified sign display strategy for displaying or omitting sign symbols.

Declaration

func sign(strategy: Decimal.FormatStyle.Configuration.SignDisplayStrategy) -> Decimal.FormatStyle

Parameters

  • strategy:

    The sign display strategy to apply to the format style, such as Automatic or Never.

Return Value

A decimal format style modified to use the specified sign display strategy.

Discussion

The following example creates a default Decimal.FormatStyle for the en_US locale, and a second style that displays a sign for all values except zero. It then applies each style to an array of decimal values. The formatting that the modified style applies adds the negative (-) or positive (+) sign to all the numbers.

let defaultStyle = FloatingPointFormatStyle<Double>(locale: Locale(identifier: "en_US"))
let alwaysStyle = defaultStyle.sign(strategy: .always(includingZero: false))
let nums = [-2.1, -1.2, 0, 1.4, 2.5]
let defaultNums = nums.map { defaultStyle.format($0) } // ["-2.1", "-1.2", "0", "1.4", "2.5"]
let alwaysNums = nums.map { alwaysStyle.format($0) } // ["-2.1", "-1.2", "0", "+1.4", "+2.5"]

See Also

Customizing style behavior