Skip to main content

Class: FlightPlanTextPanel

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:36

A flight plan text panel which displays information on up to five flight plan legs.

Extends​

Constructors​

Constructor​

new FlightPlanTextPanel(props): FlightPlanTextPanel

Defined in: src/sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsFlightPlanTextPanelPropsThe propertis of the component.

Returns​

FlightPlanTextPanel

Inherited from​

DisplayComponent.constructor

Properties​

context?​

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:70

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


props​

props: FlightPlanTextPanelProps & ComponentProps

Defined in: src/sdk/components/FSComponent.ts:64

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:195

Destroys subs and comps.

Returns​

void

Overrides​

DisplayComponent.destroy


getContext()​

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextneverThe 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(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:52

A callback that is called after the component is rendered.

Returns​

void

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


onFlightPlanTextInsetEvent()​

onFlightPlanTextInsetEvent(event): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:60

When a flight plan text update event is received.

Parameters​

ParameterTypeDescription
eventFlightPlanTextUpdateDataThe event.

Returns​

void


pause()​

pause(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:125

Pauses the text panel.

Returns​

void


render()​

render(): VNode

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:145

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DisplayComponent.render


resume()​

resume(): void

Defined in: src/workingtitle-instruments-g3000/html_ui/Shared/Components/NavigationMap/FlightPlanTextInset/FlightPlanTextPanel.tsx:118

Resumes the text panel.

Returns​

void