Class: GtcList<DataType>
A touchscreen vertically scrollable list which includes an animated scroll bar and supports rendering either a static or dynamic sequence of list items. The list also supports scrolling in response to GTC interaction events and editing of GTC sidebar state to show/hide the arrow buttons as appropriate.
Type parameters
| Name | Type |
|---|---|
DataType | extends DynamicListData |
Hierarchy
DisplayComponent<GtcListProps<DataType>>↳
GtcList
Implements
Constructors
constructor
• new GtcList<DataType>(props): GtcList<DataType>
Creates an instance of a DisplayComponent.
Type parameters
| Name | Type |
|---|---|
DataType | extends DynamicListData |
Parameters
| Name | Type | Description |
|---|---|---|
props | GtcListProps<DataType> | The propertis of the component. |
Returns
GtcList<DataType>
Inherited from
DisplayComponent<GtcListProps<DataType>>.constructor
Defined in
sdk/components/FSComponent.ts:73
Properties
context
• Optional context: [] = undefined
The context on this component, if any.
Inherited from
DisplayComponent.context
Defined in
sdk/components/FSComponent.ts:64
contextType
• Optional Readonly contextType: readonly [] = undefined
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
Defined in
sdk/components/FSComponent.ts:67
props
• props: GtcListProps<DataType> & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:386
getContext
▸ getContext(context): never
Gets a context data subscription from the context collection.
Parameters
| Name | Type | Description |
|---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
Defined in
sdk/components/FSComponent.ts:106
onAfterRender
▸ onAfterRender(): void
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:96
onBeforeRender
▸ onBeforeRender(): void
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
Defined in
sdk/components/FSComponent.ts:80
onGtcInteractionEvent
▸ onGtcInteractionEvent(event): boolean
Handles a GtcInteractionEvent.
Parameters
| Name | Type | Description |
|---|---|---|
event | GtcInteractionEvent | The event to handle. |
Returns
boolean
Whether the event was handled.
Implementation of
GtcInteractionHandler.onGtcInteractionEvent
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:266
render
▸ render(): VNode
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:348
scrollToIndex
▸ scrollToIndex(index, position, animate): void
Scrolls until the item at a specified index is in view.
Parameters
| Name | Type | Description |
|---|---|---|
index | number | The index of the item to which to scroll, after sorting has been applied and hidden items have been excluded. |
position | number | The position to place the target item at the end of the scroll. Position 0 is the top-most visible slot, position 1 is the next slot, and so on. Values greater than or equal to the number of visible items per page will be clamped. If this value is negative, the target item will be placed at the visible position that results in the shortest scroll distance. Ignored if this list does not support snapping to list items. |
animate | boolean | Whether to animate the scroll. |
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:205
scrollToItem
▸ scrollToItem(item, position, animate, ignoreIfItemInView?): void
Scrolls until the specified item is in view. If this is a static list, this method does nothing.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
item | DataType | undefined | The item to which to scroll. |
position | number | undefined | The position to place the target item at the end of the scroll. Position 0 is the top-most visible slot, position 1 is the next slot, and so on. Values greater than or equal to the number of visible items per page will be clamped. If this value is negative, the target item will be placed at the visible position that results in the shortest scroll distance. Ignored if this list does not support snapping to list items. |
animate | boolean | undefined | Whether to animate the scroll. |
ignoreIfItemInView | boolean | false | When true, if item is already in view, it will not scroll to it. Defaults to false. |
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:229
updateOrder
▸ updateOrder(): void
Updates the order of rendered items in this list.
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/GtcList.tsx:258