NumberFormat class final

Formats numbers according to locale-specific rules.

This class provides methods to format numbers, currencies, and percentages based on the current locale and various formatting options.

Example:

import 'package:intl4x/number_format.dart';

void main() {
  print(NumberFormat.format(123456.789)); // Prints '123,456.789'
}

Constructors

NumberFormat({Locale? locale, FormatStyle style = const DecimalStyle(), String? currency, SignDisplay signDisplay = SignDisplay.auto, Notation notation = const StandardNotation(), Grouping useGrouping = Grouping.auto, NumberingSystem? numberingSystem, RoundingMode roundingMode = RoundingMode.halfExpand, TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto, int minimumIntegerDigits = 1, Digits? digits})

Creates a NumberFormat instance with custom formatting options.

NumberFormat.compact({Locale? locale, CompactDisplay compactDisplay = CompactDisplay.short, FormatStyle style = const DecimalStyle(), SignDisplay signDisplay = SignDisplay.auto, Grouping useGrouping = Grouping.auto, NumberingSystem? numberingSystem, RoundingMode roundingMode = RoundingMode.halfExpand, TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto, int minimumIntegerDigits = 1, Digits? digits})

Creates a NumberFormat instance for compact number formatting.

NumberFormat.currency({Locale? locale, required String currency, CurrencyDisplay currencyDisplay = CurrencyDisplay.symbol, CurrencySign currencySign = CurrencySign.standard, SignDisplay signDisplay = SignDisplay.auto, Notation notation = const StandardNotation(), Grouping useGrouping = Grouping.auto, NumberingSystem? numberingSystem, RoundingMode roundingMode = RoundingMode.halfExpand, TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto, int minimumIntegerDigits = 1, Digits? digits})

Creates a NumberFormat instance for currency formatting.

NumberFormat.percent({Locale? locale, SignDisplay signDisplay = SignDisplay.auto, Notation notation = const StandardNotation(), Grouping useGrouping = Grouping.auto, NumberingSystem? numberingSystem, RoundingMode roundingMode = RoundingMode.halfExpand, TrailingZeroDisplay trailingZeroDisplay = TrailingZeroDisplay.auto, int minimumIntegerDigits = 1, Digits? digits})

Creates a NumberFormat instance for percent formatting.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

format(Object number) → String

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited