Interface: GtcListProps<DataType>
Component props for GtcList.
Type parameters
| Name |
|---|
DataType |
Hierarchy
ComponentProps↳
GtcListProps
Properties
bus
• bus: EventBus
The event bus.
Overrides
GtcListFormattingProps.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
ComponentProps.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.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:70
data
• Optional data: SubscribableArray<DataType>
The data to display in the list. If both this property and renderItem are defined, the list will display
rendered data items instead of its children.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:31
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
GtcListFormattingProps.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
GtcListFormattingProps.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
GtcListFormattingProps.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
GtcListFormattingProps.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.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:44
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
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
| Name | Type |
|---|---|
topVisibleIndex | number |
Returns
void
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
ComponentProps.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
| Name | Type |
|---|---|
data | DataType |
index | number |
Returns
VNode
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.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:61
sortItems
• Optional sortItems: (a: DataType, b: DataType) => number
A function to sort data items before rendering them. The function should return a negative number if the first item should be rendered before the second, a positive number if the first item should be rendered after the second, or zero if the two items' relative order does not matter. If not defined, items will be rendered in the order in which they appear in the data array.
Type declaration
▸ (a, b): number
A function to sort data items before rendering them. The function should return a negative number if the first item should be rendered before the second, a positive number if the first item should be rendered after the second, or zero if the two items' relative order does not matter. If not defined, items will be rendered in the order in which they appear in the data array.
Parameters
| Name | Type |
|---|---|
a | DataType |
b | DataType |
Returns
number
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:58
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.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:50