Class: DisplayPaneView<P, E>
A DisplayPaneView component
Type parameters
Name | Type |
---|---|
P | extends DisplayPaneViewProps = DisplayPaneViewProps |
E | extends DisplayPaneViewEvent <any > = DisplayPaneViewEvent |
Hierarchy
DisplayComponent
<P
>↳
DisplayPaneView
Constructors
constructor
• new DisplayPaneView<P
, E
>(props
): DisplayPaneView
<P
, E
>
Creates an instance of a DisplayComponent.
Type parameters
Name | Type |
---|---|
P | extends DisplayPaneViewProps = DisplayPaneViewProps |
E | extends DisplayPaneViewEvent <any , string > = 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" > |
Parameters
Name | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
DisplayPaneView
<P
, E
>
Inherited from
DisplayComponent<P>.constructor
Defined in
src/sdk/components/FSComponent.ts:73
Properties
_title
• Protected
Readonly
_title: Subject
<string
| VNode
>
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:21
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
isPfd
• Readonly
isPfd: boolean
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:25
props
• props: P
& ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
title
• Readonly
title: Subscribable
<string
| VNode
>
The title of this display pane view.
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:23
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
src/sdk/components/FSComponent.ts:98
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
onEvent
▸ onEvent(event
): void
Called when a display pane view event is received by this view.
Parameters
Name | Type | Description |
---|---|---|
event | E | The event. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:66
onPause
▸ onPause(): void
Called when this view is hidden.
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:40
onResize
▸ onResize(size
, width
, height
): void
Called when this view's parent pane is resized while this view is visible.
Parameters
Name | Type | Description |
---|---|---|
size | DisplayPaneSizeMode | The size of this view's parent pane. |
width | number | The width of this view's parent pane, in pixels. |
height | number | The height of this view's parent pane, in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:50
onResume
▸ onResume(size
, width
, height
): void
Called when this view is made visible.
Parameters
Name | Type | Description |
---|---|---|
size | DisplayPaneSizeMode | The size of this view's parent pane. |
width | number | The width of this view's parent pane, in pixels. |
height | number | The height of this view's parent pane, in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:33
onUpdate
▸ onUpdate(time
): void
Called every update cycle.
Parameters
Name | Type | Description |
---|---|---|
time | number | The current real (operating system) time, as a UNIX timestamp in milliseconds. |
Returns
void
Defined in
src/workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/Shared/Components/DisplayPanes/DisplayPaneView.ts:58
render
▸ render(): null
| VNode
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.
Inherited from
DisplayComponent.render
Defined in
src/sdk/components/FSComponent.ts:93