Type Alias: DurationDisplayOptions

DurationDisplayOptions = object

Defined in: src/sdk/components/common/DurationDisplay.tsx:36

Formatting options for DurationDisplay.

Properties

delim

delim: DurationDisplayDelim

Defined in: src/sdk/components/common/DurationDisplay.tsx:41

The delimiter to insert between parts of formatted values.

---

forceSign

forceSign: boolean

Defined in: src/sdk/components/common/DurationDisplay.tsx:59

Whether to force the display of a positive sign.

---

format

format: DurationDisplayFormat

Defined in: src/sdk/components/common/DurationDisplay.tsx:38

The format with which to display values.

---

nanString

nanString: string

Defined in: src/sdk/components/common/DurationDisplay.tsx:62

The string to display when the value is NaN.

---

numberFormatter()

numberFormatter: (value) => string

Defined in: src/sdk/components/common/DurationDisplay.tsx:47

A function used to format the last part of formatted values.

Parameters

Parameter	Type
value	number

Returns

string

---

pad

pad: number

Defined in: src/sdk/components/common/DurationDisplay.tsx:44

The number of digits to which to pad the first part of formatted values with leading zeroes.

---

showUnits

showUnits: boolean

Defined in: src/sdk/components/common/DurationDisplay.tsx:50

Whether to show units.

---

unitFormatter()

unitFormatter: (value, unit) => string

Defined in: src/sdk/components/common/DurationDisplay.tsx:53

A function used to format units.

Parameters

Parameter	Type
value	number
unit	Unit<Duration>

Returns

string

---

useMinusSign

useMinusSign: boolean

Defined in: src/sdk/components/common/DurationDisplay.tsx:56

Whether to use a minus sign (−) in place of a dash (-) in front of negative numbers.