Skip to main content

Class: TouchList

A touchscreen list which can be vertically scrolled by clicking and dragging the mouse.

Hierarchy​

Constructors​

constructor​

• new TouchList(props): TouchList

Creates an instance of a DisplayComponent.

Parameters​

NameTypeDescription
propsTouchListPropsThe propertis of the component.

Returns​

TouchList

Inherited from​

DisplayComponent<TouchListProps>.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

heightPx​

• Readonly heightPx: Subscribable<number>

The visible height of this list, in pixels.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:66

itemsPerPage​

• Readonly itemsPerPage: undefined | Subscribable<number>

The number of visible list items per page displayed by this list, or undefined if the number of items per page is not prescribed.

Defined in​

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

listItemHeightWithMarginPx​

• Readonly listItemHeightWithMarginPx: Subscribable<number>

The height, in pixels, of one item in this list plus its bottom margin.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:58

props​

• props: TouchListProps & ComponentProps

The properties of the component.

Inherited from​

DisplayComponent.props

Defined in​

sdk/components/FSComponent.ts:61

renderWindow​

• Readonly renderWindow: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

The window of rendered list items, as [startIndex, endIndex], where startIndex is the index of the first rendered item, inclusive, and endIndex is the index of the last rendered item, exclusive.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:94

scrollBarHeightPercentage​

• Readonly scrollBarHeightPercentage: Subscribable<number>

The fraction of this list's visible height compared to the total height of all items in the list plus their margins.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:84

scrollPercentage​

• Readonly scrollPercentage: Subscribable<number>

This list's current scroll position, normalized such that 0 represents when the list is scrolled to the top (without overscroll) and 1 represents when the list is scrolled to the bottom (without overscroll).

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:80

scrollY​

• Readonly scrollY: Subscribable<number>

This list's current scroll position, in pixels. The scroll position is zero when the list is scrolled to the top (without overscroll) and increases as the list is scrolled down.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:73

topVisibleIndex​

• Readonly topVisibleIndex: Subscribable<number>

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:87

totalHeightPx​

• Readonly totalHeightPx: Subscribable<number>

The total height, in pixels, of all items in this list plus their margins.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:62

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/TouchList.tsx:174

getContainerRef​

▸ getContainerRef(): HTMLDivElement

Returns a reference to the element where the list items should be added.

Returns​

HTMLDivElement

A reference to the element where the list items should be added.

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:114

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/List/TouchList.tsx:97

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

pageDown​

▸ pageDown(): void

Scrolls down by one full page height.

Returns​

void

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:128

pageUp​

▸ pageUp(): void

Scrolls up by one full page height.

Returns​

void

Defined in​

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/List/TouchList.tsx:121

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/TouchList.tsx:156

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.
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/List/TouchList.tsx:141