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

• DisplayComponent<GtcListProps<DataType>>

Type Parameters

Type Parameter
DataType extends DynamicListData

Implements

• GtcInteractionHandler

Constructors

Constructor

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

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	GtcListProps	The propertis of the component.

Returns

GtcList<DataType>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: GtcListProps<DataType> & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

renderWindow

readonly renderWindow: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "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:405

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

onAfterRender()

onAfterRender(): void

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

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

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:280

Handles a GtcInteractionEvent.

Parameters

Parameter	Type	Description
event	GtcInteractionEvent	The 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:362

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

scrollToIndex()

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

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

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

Parameters

Parameter	Type	Default value	Description
index	number	undefined	The index of the item to which to scroll, after sorting has been applied and hidden items have been excluded.
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	Whether 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:256

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

Parameters

Parameter	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	Whether 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:272

Updates the order of rendered items in this list.

Returns

void