Skip to main content

Interface: TouchListProps

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

Component props for TouchList.

Extends​

  • ComponentProps

Properties​

bus​

bus: EventBus

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

The event bus.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.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.

itemCount​

itemCount: Subscribable<number>

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

The total number of items in the list.

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.

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.

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.

maxRenderedItemCount?​

optional maxRenderedItemCount: number | Subscribable<number>

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

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

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref