Skip to main content

Class: GtcNearestWaypointList<DataType>

A scrollable GTC list of nearest waypoints.

Type parameters

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

Hierarchy

Implements

Constructors

constructor

new GtcNearestWaypointList<DataType>(props): GtcNearestWaypointList<DataType>

Creates an instance of a DisplayComponent.

Type parameters

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

Parameters

NameTypeDescription
propsGtcNearestWaypointListProps<DataType>The propertis of the component.

Returns

GtcNearestWaypointList<DataType>

Inherited from

DisplayComponent<GtcNearestWaypointListProps<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: GtcNearestWaypointListProps<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/Nearest/GtcNearestWaypointList.tsx:121


getContext

getContext(context): never

Gets a context data subscription from the context collection.

Parameters

NameTypeDescription
contextneverThe 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/Nearest/GtcNearestWaypointList.tsx:39


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

NameTypeDescription
eventGtcInteractionEventThe 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/Nearest/GtcNearestWaypointList.tsx:80


render

render(): VNode

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render

Defined in

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


scrollToIndex

scrollToIndex(index, position, animate): void

Scrolls until the item at a specified index is in view.

Parameters

NameTypeDescription
indexnumberThe index of the item to which to scroll, after sorting has been applied.
positionnumberThe 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.
animatebooleanWhether to animate the scroll.

Returns

void

Defined in

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


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

NameTypeDefault valueDescription
itemDataTypeundefinedThe item to which to scroll.
positionnumberundefinedThe 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.
animatebooleanundefinedWhether to animate the scroll.
ignoreIfItemInViewbooleanfalseWhen 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/Nearest/GtcNearestWaypointList.tsx:68


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/Nearest/GtcNearestWaypointList.tsx:75