Abstract Class: AbstractNumberUnitDisplay<F, P>

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:24

A component which displays a number with units.

Extends

• DisplayComponent<P>

Type Parameters

Type Parameter	Default type
F extends string	-
P extends AbstractNumberUnitDisplayProps<F>	AbstractNumberUnitDisplayProps<F>

Constructors

Constructor

new AbstractNumberUnitDisplay<F, P>(props): AbstractNumberUnitDisplay<F, P>

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

AbstractNumberUnitDisplay<F, P>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

displayUnit

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

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:31

A subscribable which provides the unit type in which to display the value.

---

props

props: P & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

---

value

protected readonly value: Subscribable<NumberUnitInterface<F, Unit<F>>>

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:26

A subscribable which provides the value to display.

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:57

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

Parameter	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

---

onAfterRender()

onAfterRender(): void

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:39

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onDisplayUnitChanged()

abstract protected onDisplayUnitChanged(displayUnit): void

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:54

A callback which is called when this component's bound display unit changes.

Parameters

Parameter	Type	Description
displayUnit	null | Unit<F>	The new display unit.

Returns

void

---

onValueChanged()

abstract protected onValueChanged(value): void

Defined in: src/sdk/components/common/AbstractNumberUnitDisplay.tsx:48

A callback which is called when this component's bound value changes.

Parameters

Parameter	Type	Description
value	NumberUnitInterface<F>	The new value.

Returns

void

---

render()

abstract render(): null | VNode

Defined in: src/sdk/components/FSComponent.ts:93

Renders the component.

Returns

null | VNode

A JSX element to be rendered.

Inherited from

DisplayComponent.render