Class: G3XNumberUnitDisplay<F>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:29

A G3X Touch component which displays a number with units.

Extends

• DisplayComponent<G3XNumberUnitDisplayProps<F>>

Type Parameters

Type Parameter
F extends string

Constructors

Constructor

new G3XNumberUnitDisplay<F>(props): G3XNumberUnitDisplay<F>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	G3XNumberUnitDisplayProps	The propertis of the component.

Returns

G3XNumberUnitDisplay<F>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: G3XNumberUnitDisplayProps<F> & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:100

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

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(node): void

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

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:81

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

DEFAULT_BASIC_UNIT_FORMATTER()

readonly static DEFAULT_BASIC_UNIT_FORMATTER(out, unit): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:43

A function which formats units to default basic text for G3XNumberUnitDisplay.

Parameters

Parameter	Type	Description
out	[string, string]	The 2-tuple to which to write the formatted text, as [bigText, smallText].
unit	Unit<any>	The unit to format.

Returns

void

---

DEFAULT_G3X_UNIT_FORMATTER()

readonly static DEFAULT_G3X_UNIT_FORMATTER(out, unit): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:57

A function which formats units to default G3X-style text for G3XNumberUnitDisplay.

Parameters

Parameter	Type	Description
out	[string, string]	The 2-tuple to which to write the formatted text, as [bigText, smallText].
unit	Unit<any>	The unit to format.

Returns

void

---

DEFAULT_G3X_VS_ARROW_UNIT_FORMATTER()

readonly static DEFAULT_G3X_VS_ARROW_UNIT_FORMATTER(out, unit, number): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XNumberUnitDisplay.tsx:67

A function which formats units to default G3X-style text with vertical speed arrows for G3XNumberUnitDisplay.

Parameters

Parameter	Type	Description
out	[string, string]	The 2-tuple to which to write the formatted text, as [bigText, smallText].
unit	Unit<any>	The unit to format.
number	number	The numeric value that is displayed.

Returns

void