Class: G3XNumberUnitDisplay<F>
A G3X Touch component which displays a number with units.
Type parameters
| Name | Type |
|---|---|
F | extends string |
Hierarchy
DisplayComponent<G3XNumberUnitDisplayProps<F>>↳
G3XNumberUnitDisplay
Constructors
constructor
• new G3XNumberUnitDisplay<F>(props): G3XNumberUnitDisplay<F>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
F | extends string |
Parameters
| Name | Type | Description |
|---|---|---|
props | G3XNumberUnitDisplayProps<F> | The propertis of the component. |
Returns
Inherited from
DisplayComponent<G3XNumberUnitDisplayProps<F>>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
src/sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
src/sdk/components/FSComponent.ts:67
props
• props: G3XNumberUnitDisplayProps<F> & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XNumberUnitDisplay.tsx:100
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | 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
Defined in
src/sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(node): void
A callback that is called after the component is rendered.
Parameters
| Name | Type | Description |
|---|---|---|
node | VNode | The component's VNode. |
Returns
void
Inherited from
DisplayComponent.onAfterRender
Defined in
src/sdk/components/FSComponent.ts:87
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
src/sdk/components/FSComponent.ts:80
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XNumberUnitDisplay.tsx:81
DEFAULT_BASIC_UNIT_FORMATTER
▸ DEFAULT_BASIC_UNIT_FORMATTER(out, unit): void
A function which formats units to default basic text for G3XNumberUnitDisplay.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XNumberUnitDisplay.tsx:43
DEFAULT_G3X_UNIT_FORMATTER
▸ DEFAULT_G3X_UNIT_FORMATTER(out, unit): void
A function which formats units to default G3X-style text for G3XNumberUnitDisplay.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XNumberUnitDisplay.tsx:57
DEFAULT_G3X_VS_ARROW_UNIT_FORMATTER
▸ DEFAULT_G3X_VS_ARROW_UNIT_FORMATTER(out, unit, number): void
A function which formats units to default G3X-style text with vertical speed arrows for G3XNumberUnitDisplay.
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XNumberUnitDisplay.tsx:67