Skip to main content

Interface: UiNearestWaypointListItemProps<W, EntryType>

Component props for UiNearestWaypointListItem.

Type parameters

NameType
Wextends Waypoint
EntryTypeextends NearestWaypointEntry<W> = NearestWaypointEntry<W>

Hierarchy

  • Omit<UiListItemProps, "onFocusGained" | "onFocusLost">

    UiNearestWaypointListItemProps

Properties

children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

Omit.children

Defined in

src/sdk/components/FSComponent.ts:122


class

Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

The CSS class(es) to apply to the list item's root element.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:72


compactBrgDis

Optional compactBrgDis: boolean | Subscribable<boolean>

Whether to display the bearing and distance to the waypoint in the compact form. In the compact form, the bearing and distance are stacked in a single column to take up less horizontal space. Defaults to false.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:33


designatedChildDrivesFocusable

Optional designatedChildDrivesFocusable: boolean

Whether the list item's designated focusable child determines whether the list item can be focused. If true, then the list item can be focused if and only if the designated child exists and can be focused. If false, then the list item can always be focused. Defaults to false.

Inherited from

Omit.designatedChildDrivesFocusable

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:22


entry

entry: EntryType

Data pertaining to the list item's waypoint.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:27


gduFormat

gduFormat: GduFormat

The format of the list item's parent GDU display.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:51


hideBorder

Optional hideBorder: boolean

Whether to hide the list item's border. Defaults to false.

Inherited from

Omit.hideBorder

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:25


onButtonPressed

Optional onButtonPressed: (entry: EntryType) => void

A function which is called when the list item's waypoint button is pressed.

Param

The entry for the list item's waypoint.

Type declaration

▸ (entry): void

A function which is called when the list item's waypoint button is pressed.

Parameters
NameTypeDescription
entryEntryTypeThe entry for the list item's waypoint.
Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:69


onDestroy

Optional onDestroy: () => void

A callback function to execute when the list item is destroyed.

Type declaration

▸ (): void

A callback function to execute when the list item is destroyed.

Returns

void

Inherited from

Omit.onDestroy

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiListItem.tsx:39


onFocusGained

Optional onFocusGained: (entry: EntryType) => void

A function which is called when the list item gains UI focus.

Param

The entry for the list item's waypoint.

Type declaration

▸ (entry): void

A function which is called when the list item gains UI focus.

Parameters
NameTypeDescription
entryEntryTypeThe entry for the list item's waypoint.
Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:57


onFocusLost

Optional onFocusLost: (entry: EntryType) => void

A function which is called when the list item loses UI focus.

Param

The entry for the list item's waypoint.

Type declaration

▸ (entry): void

A function which is called when the list item loses UI focus.

Parameters
NameTypeDescription
entryEntryTypeThe entry for the list item's waypoint.
Returns

void

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:63


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

Omit.ref

Defined in

src/sdk/components/FSComponent.ts:125


runwaySurfaceFilter

Optional runwaySurfaceFilter: number | Subscribable<number>

Bit flags to use for filtering runways based on surface category when displaying longest runway information for airports. Defaults to all flags set to 1 (true).

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:45


showCity

Optional showCity: boolean | Subscribable<boolean>

Whether to display city information for applicable waypoints (airports, VORs, NDBs) instead of their names. Defaults to false.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:39


unitsSettingManager

unitsSettingManager: G3XUnitsUserSettingManager

A manager for display unit settings.

Defined in

src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:48