{/* Do not edit this file. It is automatically generated by API Documenter. */}


## NumberFormatOptions

formatOption to display numbers, currency, and accounting expressed differently in each language

**Signature:**

```typescript
export interface NumberFormatOptions
```

## Remarks

Format is performed using the JavaScript standard library. [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat){/* */}

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [compactDisplay](/refs/Interface/NumberFormatOptions#compactdisplay) | "short" \| "long" | |
| [currency](/refs/Interface/NumberFormatOptions#currency) | string | |
| [currencyDisplay](/refs/Interface/NumberFormatOptions#currencydisplay) | string | |
| [currencySign](/refs/Interface/NumberFormatOptions#currencysign) | 'standard' \| 'accounting' | |
| [excelFormat](/refs/Interface/NumberFormatOptions#excelformat) | string | Specifies the format to use when output to Excel. |
| [localeMatcher](/refs/Interface/NumberFormatOptions#localematcher) | string | |
| [maximumFractionDigits](/refs/Interface/NumberFormatOptions#maximumfractiondigits) | number | |
| [maximumSignificantDigits](/refs/Interface/NumberFormatOptions#maximumsignificantdigits) | number | |
| [minimumFractionDigits](/refs/Interface/NumberFormatOptions#minimumfractiondigits) | number | |
| [minimumIntegerDigits](/refs/Interface/NumberFormatOptions#minimumintegerdigits) | number | |
| [minimumSignificantDigits](/refs/Interface/NumberFormatOptions#minimumsignificantdigits) | number | |
| [notation](/refs/Interface/NumberFormatOptions#notation) | 'standard' \| "scientific" \| "engineering" \| "compact" | |
| [numberingSystem](/refs/Interface/NumberFormatOptions#numberingsystem) | string | |
| [roundingIncrement](/refs/Interface/NumberFormatOptions#roundingincrement) | number | |
| [roundingMode](/refs/Interface/NumberFormatOptions#roundingmode) | 'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven' | |
| [roundingPriority](/refs/Interface/NumberFormatOptions#roundingpriority) | 'auto' \| 'morePrecision' \| 'lessPrecision' | |
| [signDisplay](/refs/Interface/NumberFormatOptions#signdisplay) | "auto" \| "always" \| "exceptZero" \| "never" | |
| [style](/refs/Interface/NumberFormatOptions#style) | 'decimal' \| 'currency' \| 'percent' \| 'unit' | |
| [trailingZeroDisplay](/refs/Interface/NumberFormatOptions#trailingzerodisplay) | 'auto' \| 'stripIfInteger' | |
| [unit](/refs/Interface/NumberFormatOptions#unit) | string | |
| [unitDisplay](/refs/Interface/NumberFormatOptions#unitdisplay) | "short" \| "long" \| "narrow" | |
| [useGrouping](/refs/Interface/NumberFormatOptions#usegrouping) | true \| false | |

## Properties Desc

### compactDisplay

`Type` - "short" \| "long"

<hr/>

### currency

`Type` - string

<hr/>

### currencyDisplay

`Type` - string

<hr/>

### currencySign

`Type` - 'standard' \| 'accounting'

<hr/>

### excelFormat

Specifies the format to use when output to Excel.

`Type` - string

<hr/>

### localeMatcher

`Type` - string

<hr/>

### maximumFractionDigits

`Type` - number

<hr/>

### maximumSignificantDigits

`Type` - number

<hr/>

### minimumFractionDigits

`Type` - number

<hr/>

### minimumIntegerDigits

`Type` - number

<hr/>

### minimumSignificantDigits

`Type` - number

<hr/>

### notation

`Type` - 'standard' \| "scientific" \| "engineering" \| "compact"

<hr/>

### numberingSystem

`Type` - string

<hr/>

### roundingIncrement

`Type` - number

<hr/>

### roundingMode

`Type` - 'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'

<hr/>

### roundingPriority

`Type` - 'auto' \| 'morePrecision' \| 'lessPrecision'

<hr/>

### signDisplay

`Type` - "auto" \| "always" \| "exceptZero" \| "never"

<hr/>

### style

`Type` - 'decimal' \| 'currency' \| 'percent' \| 'unit'

<hr/>

### trailingZeroDisplay

`Type` - 'auto' \| 'stripIfInteger'

<hr/>

### unit

`Type` - string

<hr/>

### unitDisplay

`Type` - "short" \| "long" \| "narrow"

<hr/>

### useGrouping

`Type` - true \| false

<hr/>