Interface: UiFlightPlanListProps
Component props for UiFlightPlanList.
Hierarchy
Omit<UiListProps<FlightPlanDataItem>,"itemsPerPage"|"sortItems"|"data"|"staticChildren">↳
UiFlightPlanListProps
Properties
animateScrollToFocus
• Optional animateScrollToFocus: boolean | Subscribable<boolean>
Whether to animate scrolling when the list automatically scrolls to a newly focused item. Defaults to true.
Inherited from
Omit.animateScrollToFocus
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:80
autoDisableOverscroll
• Optional autoDisableOverscroll: boolean | Subscribable<boolean>
Whether to automatically disable overscrolling when the total height of all the list's items does not exceed the
list's visible height. Defaults to false.
Inherited from
Omit.autoDisableOverscroll
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:61
autoRefocus
• Optional autoRefocus: boolean
Whether the list should automatically try to focus another item if the focused item loses focus because it could
no longer be focused or if it was removed from the list. Defaults to false.
Inherited from
Omit.autoRefocus
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:86
bus
• bus: EventBus
The event bus.
Inherited from
Omit.bus
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:30
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>
CSS class(es) to add to the list's root element.
Inherited from
Omit.class
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:109
data
• data: FlightPlanDataArray
The flight plan data to display in the list.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FlightPlan/UiFlightPlanList.tsx:22
fadeScrollBar
• Optional fadeScrollBar: boolean | Subscribable<boolean>
Whether to fade out the scroll bar when the total height of all the list's items is less than or equal to the
list's visible height. Space is reserved for the scroll bar even when it is faded out. Defaults to true.
Inherited from
Omit.fadeScrollBar
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:75
gduFormat
• gduFormat: GduFormat
The format of the list's parent GDU.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FlightPlan/UiFlightPlanList.tsx:28
itemsPerPage
• itemsPerPage: number | Subscribable<number>
The number of visible items per page.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/FlightPlan/UiFlightPlanList.tsx:25
lengthPx
• Optional lengthPx: number | Subscribable<number>
The length of the list, in pixels, along its scroll axis. If not defined, then the default value depends on whether the number of items per page is defined. If the number of items per page is defined, then the length defaults to the sum of the list item length and spacing multiplied by the number of items per page. If the number of items per page is not defined, then the length defaults to 100 pixels.
Inherited from
Omit.lengthPx
Defined in
src/garminsdk/components/list/ScrollList.tsx:34
listItemLengthPx
• listItemLengthPx: number | Subscribable<number>
The length of each list item, in pixels, along the list's scroll axis.
Inherited from
Omit.listItemLengthPx
Defined in
src/garminsdk/components/list/ScrollList.tsx:17
listItemSpacingPx
• Optional listItemSpacingPx: number | Subscribable<number>
The amount of space between each list item in pixels. Defaults to zero pixels.
Inherited from
Omit.listItemSpacingPx
Defined in
src/garminsdk/components/list/ScrollList.tsx:20
maxOverscrollPx
• Optional maxOverscrollPx: number | Subscribable<number>
The maximum distance the list can overscroll past the beginning and end, in pixels. Defaults to the length of one list item.
Inherited from
Omit.maxOverscrollPx
Defined in
src/garminsdk/components/list/ScrollList.tsx:26
maxRenderedItemCount
• Optional maxRenderedItemCount: number | Subscribable<number>
The maximum number of items that can be rendered simultaneously. Ignored if data, renderItem, or
itemsPerPage is not defined. The value will be clamped to be greater than or equal to itemsPerPage * 3.
Defaults to infinity.
Inherited from
Omit.maxRenderedItemCount
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:55
onDestroy
• Optional onDestroy: () => void
A callback function to execute when the list is destroyed.
Type declaration
▸ (): void
A callback function to execute when the list 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/UiList.tsx:106
onTopVisibleIndexChanged
• Optional onTopVisibleIndexChanged: (topVisibleIndex: number) => void
A callback that will be called with the topVisibleIndex when it changes.
Type declaration
▸ (topVisibleIndex): void
A callback that will be called with the topVisibleIndex when it changes.
Parameters
| Name | Type |
|---|---|
topVisibleIndex | number |
Returns
void
Inherited from
Omit.onTopVisibleIndexChanged
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:103
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Omit.ref
Defined in
src/sdk/components/FSComponent.ts:125
renderItem
• Optional renderItem: (data: FlightPlanDataItem, index: number) => VNode
A function that renders a single data item into the list. If both this property and data are defined, the
list will display rendered data items instead of its children.
Type declaration
▸ (data, index): VNode
A function that renders a single data item into the list. If both this property and data are defined, the
list will display rendered data items instead of its children.
Parameters
| Name | Type |
|---|---|
data | FlightPlanDataItem |
index | number |
Returns
VNode
Inherited from
Omit.renderItem
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:48
showScrollBar
• Optional showScrollBar: boolean | "auto" | Subscribable<boolean | "auto">
Whether to show the list's scroll bar. If true, then space is always reserved for the scroll bar, and its
visibility depends on the fadeScrollBar option. If false, then no space is reserved for the scroll bar and it
is always hidden. If auto, then space is reserved for the scroll bar if and only if the total height of all the
list's items exceeds the list's visible height. Defaults to true.
Inherited from
Omit.showScrollBar
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:69
validKnobIds
• Optional validKnobIds: Iterable<UiKnobId>
The IDs of the valid bezel rotary knobs that can be used to change the list's focused item. If not defined, then knobs cannot be used to change the list's focused item.
Inherited from
Omit.validKnobIds
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/List/UiList.tsx:36