Class: Epic2StartupDisplayComponent
Defined in: workingtitle-instruments-epic2/shared/Misc/Epic2StartupScreen.tsx:4
A startup screen for an Epic 2 display (amber cross)
Extends
Constructors
Constructor
new Epic2StartupDisplayComponent(
props
):Epic2StartupDisplayComponent
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | ComponentProps | The propertis of the component. |
Returns
Epic2StartupDisplayComponent
Inherited from
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
props
props:
ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
Methods
destroy()
destroy():
void
Defined in: sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
Inherited from
getContext()
protected
getContext(context
):never
Defined in: 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
onAfterRender()
onAfterRender(
node
):void
Defined in: 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: 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: workingtitle-instruments-epic2/shared/Misc/Epic2StartupScreen.tsx:8
Renders the component.
Returns
A JSX element to be rendered.
Overrides
setVisibility()
setVisibility(
visible
):void
Defined in: workingtitle-instruments-epic2/shared/Misc/Epic2StartupScreen.tsx:23
Sets the visibility of the boot startup screen
Parameters
Parameter | Type | Description |
---|---|---|
visible | boolean | Whether it should be visible |
Returns
void