Skip to main content

Class: GtcList<DataType>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:79

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.

Extends

Type Parameters

Type Parameter
DataType extends DynamicListData

Implements

Constructors

Constructor

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

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

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsGtcListPropsThe propertis of the component.

Returns

GtcList<DataType>

Inherited from

DisplayComponent<GtcListProps<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: GtcListProps<DataType> & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props


renderWindow

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

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:90

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. These indexes are defined after item sorting and visibility have been taken into account, such that index i refers to the ith visible item in sorted order.

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:399

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/List/GtcList.tsx:105

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/List/GtcList.tsx:279

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/List/GtcList.tsx:361

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render


scrollToIndex()

scrollToIndex(index, position, animate, ignoreIfItemInView): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:218

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

Parameters

ParameterTypeDefault valueDescription
indexnumberundefinedThe index of the item to which to scroll, after sorting has been applied and hidden items have been excluded.
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.
ignoreIfItemInViewbooleanfalseWhether to skip the scroll operation if the target item is already in view or will be in view when the current scrolling animation finishes. Defaults to false.

Returns

void


scrollToItem()

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

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:255

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.
ignoreIfItemInViewbooleanfalseWhether to skip the scroll operation if the target item is already in view or will be in view when the current scrolling animation finishes. Defaults to false.

Returns

void


updateOrder()

updateOrder(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/GtcList.tsx:271

Updates the order of rendered items in this list.

Returns

void