Skip to main content

Class: GtcPfdSettingsPage

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:26

A GTC PFD settings page.

Extends

Constructors

Constructor

new GtcPfdSettingsPage(props): GtcPfdSettingsPage

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsGtcPfdSettingsPagePropsThe propertis of the component.

Returns

GtcPfdSettingsPage

Inherited from

GtcView.constructor

Properties

_activeComponent

protected readonly _activeComponent: Subject<null | GtcInteractionHandler>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:34

Inherited from

GtcView._activeComponent


_sidebarState

protected readonly _sidebarState: GtcSidebarState

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:36

Inherited from

GtcView._sidebarState


_title

protected readonly _title: Subject<undefined | string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:40

Inherited from

GtcView._title


bus

protected readonly bus: EventBus

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:31

Inherited from

GtcView.bus


context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

GtcView.context


contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

GtcView.contextType


gtcService

protected readonly gtcService: GtcService

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:32

Inherited from

GtcView.gtcService


props

props: GtcPfdSettingsPageProps & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

GtcView.props


sidebarState

readonly sidebarState: SidebarStateReadonly

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:38

The GTC sidebar state (labels and buttons) requested by this view.

Inherited from

GtcView.sidebarState


title

readonly title: Subscribable<undefined | string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:28

This view's title.

Overrides

GtcView.title

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:195

Destroys this component.

Returns

void

Overrides

GtcView.destroy


getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

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

GtcView.getContext


onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:41

A callback that is called after the component is rendered.

Returns

void

Overrides

GtcView.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

GtcView.onBeforeRender


onClose()

onClose(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:75

A method that is called when this view is closed. A view is closed when it does not appear in the most recent history state of its parent view stack.

Returns

void

Inherited from

GtcView.onClose


onGtcInteractionEvent()

onGtcInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:97

Called when there is an interaction event when this is the active view.

Parameters

ParameterTypeDescription
eventGtcInteractionEventThe event.

Returns

boolean

Whether the event was handled or not.

Inherited from

GtcView.onGtcInteractionEvent


onInUse()

onInUse(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:48

A method that is called when this view comes into use. A view is in-use when it appears in at least one history state of its parent view stack.

Returns

void

Inherited from

GtcView.onInUse


onOpen()

onOpen(wasPreviouslyOpened): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:67

A method that is called when this view is opened. A view is open when it appears in the most recent history state of its parent view stack.

Parameters

ParameterTypeDescription
wasPreviouslyOpenedbooleanTrue when this view was open in a previous view stack (like if the go back button was used to reach this page).

Returns

void

Inherited from

GtcView.onOpen


onOutOfUse()

onOutOfUse(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:56

A method that is called when this view goes out of use. A view is out-of-use when it does not appear in any history states of its parent view stack.

Returns

void

Inherited from

GtcView.onOutOfUse


onPause()

onPause(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:53

A method that is called when this view is paused. A view is paused when it is not the active view.

Returns

void

Overrides

GtcView.onPause


onResume()

onResume(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:48

A method that is called when this view is resumed. A view is resumed when it is the active view.

Returns

void

Overrides

GtcView.onResume


render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Pages/PfdSettingsPage/GtcPfdSettingsPage.tsx:58

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

GtcView.render