Skip to main content

Interface: MfdPageNavBarProps

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

Component props for MfdPageNavBar.

Extends​

Properties​

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

labelWidth​

labelWidth: number

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

The width of the each page label, in pixels, in the navigation bar's page list.

maxLabelsPerListPage​

maxLabelsPerListPage: Subscribable<number>

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

The maximum number of page labels to show simultaneously in the navigation bar's page list.

onPageSelected()​

onPageSelected: (pageDef) => void

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

A function which is called when a page is selected through the navigation bar.

Parameters​

ParameterTypeDescription
pageDefReadonly<MfdPageDefinition>The definition for the selected page.

Returns​

void

pageDefs​

pageDefs: Iterable<Readonly<MfdPageDefinition>>

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

An iterable of definitions for the navigation bar's selectable pages in the order in which their labels should appear in the navigation bar's page list.

pageSelectDialogKey​

pageSelectDialogKey: string

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

The key of the page select dialog to open when the navigation bar is pressed.

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

selectedPageIconSrc​

selectedPageIconSrc: Subscribable<string>

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

The file path to the selected page's icon image asset.

selectedPageKey​

selectedPageKey: Subscribable<string>

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

The key of the selected page.

selectedPageTitle​

selectedPageTitle: Subscribable<string>

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

The selected page's title.

uiService​

uiService: UiService

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

The UI service instance.