Class: MfdPageNavBar

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:60

An MFD page navigation bar.

Extends

• DisplayComponent<MfdPageNavBarProps>

Implements

• UiInteractionHandler

Constructors

Constructor

new MfdPageNavBar(props): MfdPageNavBar

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MfdPageNavBarProps	The propertis of the component.

Returns

MfdPageNavBar

Inherited from

DisplayComponent.constructor

Properties

_knobLabelState

protected readonly _knobLabelState: FilteredMapSubject<UiKnobId, string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:71

---

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

---

knobLabelState

readonly knobLabelState: Subscribable<UiKnobRequestedLabelState>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:73

Inherit Doc

---

props

props: MfdPageNavBarProps & 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-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:323

Destroys this component.

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

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

---

onAfterRender()

onAfterRender(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:97

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

---

onUiInteractionEvent()

onUiInteractionEvent(event): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:237

Handles a UiInteractionEvent.

Parameters

Parameter	Type	Description
event	UiInteractionEvent	The event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

UiInteractionHandler.onUiInteractionEvent

---

pause()

pause(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:132

Pauses this navigation bar.

Returns

void

---

render()

render(): VNode

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:277

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

resume()

resume(): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/PageNavigation/MfdPageNavBar.tsx:125

Resumes this navigation bar. When this bar is resumed, it will handle

Returns

void