Class: G3XTimeDisplay
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:27
A G3X Touch component which displays a time value.
Extends
DisplayComponent
<G3XTimeDisplayProps
>
Constructors
Constructor
new G3XTimeDisplay(
props
):G3XTimeDisplay
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | G3XTimeDisplayProps | The propertis of the component. |
Returns
G3XTimeDisplay
Inherited from
DisplayComponent<G3XTimeDisplayProps>.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
props
props:
G3XTimeDisplayProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
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/G3XTimeDisplay.tsx:99
Returns
void
Inherit Doc
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(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
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:80
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/G3XTimeDisplay.tsx:79
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
DEFAULT_STANDARD_SUFFIX_FORMATTER()
readonly
static
DEFAULT_STANDARD_SUFFIX_FORMATTER(onlyShowAmPm
,format
,isAm
):string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:36
A function which formats standard suffixes for G3XTimeDisplay.
Parameters
Parameter | 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.
DEFAULT_VERTICAL_SUFFIX_FORMATTER()
readonly
static
DEFAULT_VERTICAL_SUFFIX_FORMATTER(onlyShowAmPm
,format
,isAm
):string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Common/G3XTimeDisplay.tsx:57
A function which formats vertical suffixes for G3XTimeDisplay.
Parameters
Parameter | 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.