Interface: MfdPageNavBarProps
Component props for MfdPageNavBar.
Hierarchy
ComponentProps
↳
MfdPageNavBarProps
Properties
children
• Optional
children: DisplayChildren
[]
The children of the display component.
Inherited from
ComponentProps.children
Defined in
src/sdk/components/FSComponent.ts:122
labelWidth
• labelWidth: number
The width of the each page label, in pixels, in the navigation bar's page list.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:42
maxLabelsPerListPage
• maxLabelsPerListPage: Subscribable
<number
>
The maximum number of page labels to show simultaneously in the navigation bar's page list.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:45
onPageSelected
• onPageSelected: (pageDef
: Readonly
<MfdPageDefinition
>) => void
A function which is called when a page is selected through the navigation bar.
Param
The definition for the selected page.
Type declaration
▸ (pageDef
): void
A function which is called when a page is selected through the navigation bar.
Parameters
Name | Type | Description |
---|---|---|
pageDef | Readonly <MfdPageDefinition > | The definition for the selected page. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:54
pageDefs
• pageDefs: Iterable
<Readonly
<MfdPageDefinition
>>
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.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:27
pageSelectDialogKey
• pageSelectDialogKey: string
The key of the page select dialog to open when the navigation bar is pressed.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:48
ref
• Optional
ref: NodeReference
<any
>
A reference to the display component.
Inherited from
ComponentProps.ref
Defined in
src/sdk/components/FSComponent.ts:125
selectedPageIconSrc
• selectedPageIconSrc: Subscribable
<string
>
The file path to the selected page's icon image asset.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:39
selectedPageKey
• selectedPageKey: Subscribable
<string
>
The key of the selected page.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:33
selectedPageTitle
• selectedPageTitle: Subscribable
<string
>
The selected page's title.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:36
uiService
• uiService: UiService
The UI service instance.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/PageNavigation/MfdPageNavBar.tsx:30