Interface: UiNearestWaypointListItemProps<W, EntryType>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:22
Component props for UiNearestWaypointListItem.
Extends
Omit
<UiListItemProps
,"onFocusGained"
|"onFocusLost"
>
Type Parameters
Type Parameter | Default type |
---|---|
W extends Waypoint | - |
EntryType extends NearestWaypointEntry <W > | NearestWaypointEntry <W > |
Properties
children?
optional
children:DisplayChildren
[]
Defined in: src/sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
Omit.children
class?
optional
class:string
|ToggleableClassNameRecord
|SubscribableSet
<string
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:72
The CSS class(es) to apply to the list item's root element.
compactBrgDis?
optional
compactBrgDis:boolean
|Subscribable
<boolean
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:33
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
.
designatedChildDrivesFocusable?
optional
designatedChildDrivesFocusable:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:22
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
entry
entry:
EntryType
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:27
Data pertaining to the list item's waypoint.
gduFormat
gduFormat:
GduFormat
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:51
The format of the list item's parent GDU display.
hideBorder?
optional
hideBorder:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:25
Whether to hide the list item's border. Defaults to false
.
Inherited from
Omit.hideBorder
onButtonPressed()?
optional
onButtonPressed: (entry
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:69
A function which is called when the list item's waypoint button is pressed.
Parameters
Parameter | Type | Description |
---|---|---|
entry | EntryType | The entry for the list item's waypoint. |
Returns
void
onDestroy()?
optional
onDestroy: () =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/List/UiListItem.tsx:39
A callback function to execute when the list item is destroyed.
Returns
void
Inherited from
Omit.onDestroy
onFocusGained()?
optional
onFocusGained: (entry
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:57
A function which is called when the list item gains UI focus.
Parameters
Parameter | Type | Description |
---|---|---|
entry | EntryType | The entry for the list item's waypoint. |
Returns
void
onFocusLost()?
optional
onFocusLost: (entry
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:63
A function which is called when the list item loses UI focus.
Parameters
Parameter | Type | Description |
---|---|---|
entry | EntryType | The entry for the list item's waypoint. |
Returns
void
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
Omit.ref
runwaySurfaceFilter?
optional
runwaySurfaceFilter:number
|Subscribable
<number
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:45
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
).
showCity?
optional
showCity:boolean
|Subscribable
<boolean
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:39
Whether to display city information for applicable waypoints (airports, VORs, NDBs) instead of their names.
Defaults to false
.
unitsSettingManager
unitsSettingManager:
G3XUnitsUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/Nearest/UiNearestWaypointListItem.tsx:48
A manager for display unit settings.