Skip to main content

Class: GtcNearestWaypointList<DataType>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:25

A scrollable GTC list of nearest waypoints.

Extends

Type Parameters

Type ParameterDefault type
DataType extends NearestWaypointEntry<FacilityWaypoint> & DynamicListDataNearestWaypointEntry<FacilityWaypoint & DynamicListData>

Implements

Constructors

Constructor

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

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsGtcNearestWaypointListPropsThe propertis of the component.

Returns

GtcNearestWaypointList<DataType>

Inherited from

DisplayComponent<GtcNearestWaypointListProps<DataType>>.constructor

Properties

context?

optional context: [] = undefined

Defined in: sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


props

props: GtcNearestWaypointListProps<DataType> & ComponentProps

Defined in: sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:121

Returns

void

Inherit Doc

Overrides

DisplayComponent.destroy


getContext()

protected getContext(context): never

Defined in: sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
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


onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:39

Returns

void

Inherit Doc

Overrides

DisplayComponent.onAfterRender


onBeforeRender()

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


onGtcInteractionEvent()

onGtcInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:80

Handles a GtcInteractionEvent.

Parameters

ParameterTypeDescription
eventGtcInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

GtcInteractionHandler.onGtcInteractionEvent


render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:85

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render


scrollToIndex()

scrollToIndex(index, position, animate): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:54

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

Parameters

ParameterTypeDescription
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


scrollToItem()

scrollToItem(item, position, animate, ignoreIfItemInView): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:68

Scrolls until the specified item is in view. If this is a static list, this method does nothing.

Parameters

ParameterTypeDefault 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


updateOrder()

updateOrder(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Nearest/GtcNearestWaypointList.tsx:75

Updates the order of rendered items in this list.

Returns

void