Class: DisplayPane
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:64
The DisplayPane component.
Extends
DisplayComponent
<DisplayPaneProps
>
Constructors
Constructor
new DisplayPane(
props
):DisplayPane
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | DisplayPaneProps | The propertis of the component. |
Returns
DisplayPane
Inherited from
DisplayComponent<DisplayPaneProps>.constructor
Properties
activeView
readonly
activeView:Subscribable
<null
|DisplayPaneView
<DisplayPaneViewProps
,DisplayPaneViewEvent
<DisplayPaneViewEventTypes
,"display_pane_map_range_inc"
|"display_pane_map_range_dec"
|"display_pane_map_pointer_active_set"
|"display_pane_map_pointer_active_toggle"
|"display_pane_map_pointer_move"
>>>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:79
The currently active view.
activeViewKey
readonly
activeViewKey:Subscribable
<string
>
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:77
The key of the currently active view.
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:
DisplayPaneProps
&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-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:405
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
isAwake()
isAwake():
boolean
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:155
Checks whether this pane is awake.
Returns
boolean
Whether this pane is awake.
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:102
Returns
void
Inherit Doc
Overrides
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-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:383
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
sleep()
sleep():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:192
Puts this pane to sleep. This will pause this pane's active view (if one exists) and suspend handling of display pane view events.
Returns
void
Throws
Error if this pane has been destroyed.
update()
update(
time
):void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:219
Updates this display pane. Has no effect if this display pane is not visible.
Parameters
Parameter | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a UNIX timestamp in milliseconds. |
Returns
void
wake()
wake():
void
Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/DisplayPanes/DisplayPane.tsx:164
Wakes this pane. This will resume this pane's active view (if one exists) and resume handling of display pane view events.
Returns
void
Throws
Error if this pane has been destroyed.