Skip to main content

Interface: GtcNearestWaypointListProps<DataType>

Component props for GtcNearestWaypointList.

Type parameters

NameType
DataTypeextends NearestWaypointEntry<FacilityWaypoint> & DynamicListData = NearestWaypointEntry<FacilityWaypoint & DynamicListData>

Hierarchy

  • Omit<GtcListProps<DataType>, "sortItems" | "data">

    GtcNearestWaypointListProps

Properties

bus

bus: EventBus

The event bus.

Inherited from

Omit.bus

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:25


children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

Omit.children

Defined in

sdk/components/FSComponent.ts:122


class

Optional class: string | SubscribableSet<string>

CSS class(es) to add to the list's root element.

Inherited from

Omit.class

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:70


data

data: SubscribableArray<DataType>

The data to display in the list.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/Nearest/GtcNearestWaypointList.tsx:16


heightPx

Optional heightPx: number | Subscribable<number>

The height of the list in pixels. If not defined, the default value depends on whether the number of items per page is defined. If the number of items per page is defined, the height defaults to the sum of the list item height and spacing multiplied by the number of items per page. If the number of items per page is not defined, the height defaults to 100 pixels.

Inherited from

Omit.heightPx

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:29


itemsPerPage

Optional itemsPerPage: number | Subscribable<number>

The number of visible items per page. If not defined, the list will not snap to list items when scrolling.

Inherited from

Omit.itemsPerPage

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:32


listItemHeightPx

listItemHeightPx: number | Subscribable<number>

The height of each list item in pixels.

Inherited from

Omit.listItemHeightPx

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:18


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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:21


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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:44


noResultsText

noResultsText: string | Subscribable<string>

The text to display when the list is empty.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/Nearest/GtcNearestWaypointList.tsx:19


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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:67


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
NameType
topVisibleIndexnumber
Returns

void

Inherited from

Omit.onTopVisibleIndexChanged

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:64


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

Omit.ref

Defined in

sdk/components/FSComponent.ts:125


renderItem

Optional renderItem: (data: DataType, 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
NameType
dataDataType
indexnumber
Returns

VNode

Inherited from

Omit.renderItem

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:37


sidebarState

Optional sidebarState: GtcSidebarState | Subscribable<null | GtcSidebarState>

The SidebarState to use.

Inherited from

Omit.sidebarState

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:61


staticTouchListChildren

Optional staticTouchListChildren: VNode

A VNode which will be rendered into the list's translating container and positioned after the container that holds the list's rendered items.

Inherited from

Omit.staticTouchListChildren

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:50