Class: G3XTimeDisplay
A G3X Touch component which displays a time value.
Hierarchy
DisplayComponent<G3XTimeDisplayProps>↳
G3XTimeDisplay
Constructors
constructor
• new G3XTimeDisplay(props): G3XTimeDisplay
Creates an instance of a DisplayComponent.
Parameters
| Name | Type | Description |
|---|---|---|
props | G3XTimeDisplayProps | The propertis of the component. |
Returns
Inherited from
DisplayComponent<G3XTimeDisplayProps>.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: G3XTimeDisplayProps & 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/G3XTimeDisplay.tsx:99
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/G3XTimeDisplay.tsx:79
DEFAULT_STANDARD_SUFFIX_FORMATTER
▸ DEFAULT_STANDARD_SUFFIX_FORMATTER(onlyShowAmPm, format, isAm): string
A function which formats standard suffixes for G3XTimeDisplay.
Parameters
| Name | Type | Description |
|---|---|---|
onlyShowAmPm | boolean | Whether to only show the 'AM/PM' suffix. |
format | TimeDisplayFormat | The current format used to display the time. |
isAm | boolean | Whether or not the current time is AM. |
Returns
string
The suffix to append to the displayed time.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XTimeDisplay.tsx:36
DEFAULT_VERTICAL_SUFFIX_FORMATTER
▸ DEFAULT_VERTICAL_SUFFIX_FORMATTER(onlyShowAmPm, format, isAm): string
A function which formats vertical suffixes for G3XTimeDisplay.
Parameters
| Name | Type | Description |
|---|---|---|
onlyShowAmPm | boolean | Whether to only show the 'AM/PM' suffix. |
format | TimeDisplayFormat | The current format used to display the time. |
isAm | boolean | Whether or not the current time is AM. |
Returns
string
The suffix to append to the displayed time.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Common/G3XTimeDisplay.tsx:57