Interface: GtcNearestWaypointListProps<DataType>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:11
Component props for GtcNearestWaypointList.
Extends
Omit
<GtcListProps
<DataType
>,"sortItems"
|"data"
>
Type Parameters
Type Parameter | Default type |
---|---|
DataType extends NearestWaypointEntry <FacilityWaypoint > & DynamicListData | NearestWaypointEntry <FacilityWaypoint & DynamicListData > |
Properties
bus
bus:
EventBus
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:26
The event bus.
Inherited from
Omit.bus
children?
optional
children:DisplayChildren
[]
Defined in: sdk/components/FSComponent.ts:122
The children of the display component.
Inherited from
Omit.children
class?
optional
class:string
|SubscribableSet
<string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:71
CSS class(es) to add to the list's root element.
Inherited from
Omit.class
data
data:
SubscribableArray
<DataType
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:16
The data to display in the list.
heightPx?
optional
heightPx:number
|Subscribable
<number
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:29
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
itemsPerPage?
optional
itemsPerPage:number
|Subscribable
<number
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:32
The number of visible items per page. If not defined, the list will not snap to list items when scrolling.
Inherited from
Omit.itemsPerPage
listItemHeightPx
listItemHeightPx:
number
|Subscribable
<number
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:18
The height of each list item in pixels.
Inherited from
Omit.listItemHeightPx
listItemSpacingPx?
optional
listItemSpacingPx:number
|Subscribable
<number
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:21
The amount of space between each list item in pixels. Defaults to zero pixels.
Inherited from
Omit.listItemSpacingPx
maxRenderedItemCount?
optional
maxRenderedItemCount:number
|Subscribable
<number
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:45
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
noResultsText
noResultsText:
string
|Subscribable
<string
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:19
The text to display when the list is empty.
onDestroy()?
optional
onDestroy: () =>void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:68
A callback function to execute when the list is destroyed.
Returns
void
Inherited from
Omit.onDestroy
onTopVisibleIndexChanged()?
optional
onTopVisibleIndexChanged: (topVisibleIndex
) =>void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:65
A callback that will be called with the topVisibleIndex when it changes.
Parameters
Parameter | Type |
---|---|
topVisibleIndex | number |
Returns
void
Inherited from
Omit.onTopVisibleIndexChanged
ref?
optional
ref:NodeReference
<any
>
Defined in: sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
Omit.ref
renderItem()?
optional
renderItem: (data
,index
) =>VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:38
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
Parameter | Type |
---|---|
data | DataType |
index | number |
Returns
VNode
Inherited from
Omit.renderItem
sidebarState?
optional
sidebarState:GtcSidebarState
|Subscribable
<null
|GtcSidebarState
>
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:62
The SidebarState to use.
Inherited from
Omit.sidebarState
staticTouchListChildren?
optional
staticTouchListChildren:VNode
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:51
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