Interface: GtcListProps<DataType>

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

Component props for GtcList.

Extends

• ComponentProps.GtcListFormattingProps

Type Parameters

Type Parameter
DataType

Properties

bus

bus: EventBus

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

The event bus.

Overrides

GtcListFormattingProps.bus

---

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

ComponentProps.children

---

class?

optional class: string | SubscribableSet<string>

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

CSS class(es) to add to the list's root element.

---

data?

optional data: SubscribableArray<DataType>

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

The data to display in the list. If both this property and renderItem are defined, the list will display rendered data items instead of its children.

---

heightPx?

optional heightPx: number | Subscribable<number>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:29

The height of the list in pixels. If not defined, the default value depends on whether the number of items per page is defined. If the number of items per page is defined, the height defaults to the sum of the list item height and spacing multiplied by the number of items per page. If the number of items per page is not defined, the height defaults to 100 pixels.

Inherited from

GtcListFormattingProps.heightPx

---

itemsPerPage?

optional itemsPerPage: number | Subscribable<number>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:32

The number of visible items per page. If not defined, the list will not snap to list items when scrolling.

Inherited from

GtcListFormattingProps.itemsPerPage

---

listItemHeightPx

listItemHeightPx: number | Subscribable<number>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:18

The height of each list item in pixels.

Inherited from

GtcListFormattingProps.listItemHeightPx

---

listItemSpacingPx?

optional listItemSpacingPx: number | Subscribable<number>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/List/TouchList.tsx:21

The amount of space between each list item in pixels. Defaults to zero pixels.

Inherited from

GtcListFormattingProps.listItemSpacingPx

---

maxRenderedItemCount?

optional maxRenderedItemCount: number | Subscribable<number>

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

The maximum number of items that can be rendered simultaneously. Ignored if data, renderItem, or itemsPerPage is not defined. The value will be clamped to be greater than or equal to itemsPerPage * 3. Defaults to infinity.

---

onDestroy()?

optional onDestroy: () => void

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

A callback function to execute when the list is destroyed.

Returns

void

---

onTopVisibleIndexChanged()?

optional onTopVisibleIndexChanged: (topVisibleIndex) => void

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

A callback that will be called with the topVisibleIndex when it changes.

Parameters

Parameter	Type
topVisibleIndex	number

Returns

void

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

ComponentProps.ref

---

renderItem()?

optional renderItem: (data, index) => VNode

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

A function that renders a single data item into the list. If both this property and data are defined, the list will display rendered data items instead of its children.

Parameters

Parameter	Type
data	DataType
index	number

Returns

VNode

---

sidebarState?

optional sidebarState: GtcSidebarState | Subscribable<null | GtcSidebarState>

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

The SidebarState to use.

---

sortItems()?

optional sortItems: (a, b) => number

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

A function to sort data items before rendering them. The function should return a negative number if the first item should be rendered before the second, a positive number if the first item should be rendered after the second, or zero if the two items' relative order does not matter. If not defined, items will be rendered in the order in which they appear in the data array.

Parameters

Parameter	Type
a	DataType
b	DataType

Returns

number

---

staticTouchListChildren?

optional staticTouchListChildren: VNode

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

A VNode which will be rendered into the list's translating container and positioned after the container that holds the list's rendered items.