Interface: NumberDisplayProps<F>

Defined in: workingtitle-instruments-epic2/shared/Components/NumberDisplays/NumberDisplay.tsx:9

Component props for NumberDisplay.

Extends

• ComponentProps

Type Parameters

Type Parameter
F extends string

Properties

children?

optional children: DisplayChildren[]

Defined in: sdk/components/FSComponent.ts:125

The children of the display component.

Inherited from

ComponentProps.children

---

class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: workingtitle-instruments-epic2/shared/Components/NumberDisplays/NumberDisplay.tsx:23

CSS class(es) to add to the root of the icon component.

---

displayUnit

displayUnit: Unit<F> | Subscribable<Unit<F> | null> | null

Defined in: workingtitle-instruments-epic2/shared/Components/NumberDisplays/NumberDisplay.tsx:17

The unit type in which to display the value, or a subscribable which provides it. If the unit is null, then the native type of the value is used instead.

---

formatter()

formatter: (number) => string

Defined in: workingtitle-instruments-epic2/shared/Components/NumberDisplays/NumberDisplay.tsx:20

A function which formats numbers.

Parameters

Parameter	Type
number	number

Returns

string

---

ref?

optional ref: NodeReference<any>

Defined in: sdk/components/FSComponent.ts:128

A reference to the display component.

Inherited from

ComponentProps.ref

---

value

value: NumberUnitInterface<F, Unit<F>> | Subscribable<NumberUnitInterface<F, Unit<F>>>

Defined in: workingtitle-instruments-epic2/shared/Components/NumberDisplays/NumberDisplay.tsx:11

The NumberUnitInterface value to display, or a subscribable which provides it.