Class: Epic2List<DataType>

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:88

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<Epic2ListProps<DataType>>

Type Parameters

Type Parameter
DataType extends DynamicListData

Constructors

Constructor

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

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	Epic2ListProps	The propertis of the component.

Returns

Epic2List<DataType>

Inherited from

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

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:409

Destroys this component.

Returns

void

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

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-epic2/shared/Components/List/Epic2List.tsx:109

A callback that is called after the component is rendered.

Returns

void

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

---

render()

render(): VNode

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:366

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

scrollToIndex()

scrollToIndex(index, position, animate): void

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:222

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

Parameters

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

Returns

void

---

scrollToItem()

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

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:246

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	When true, if item is already in view, it will not scroll to it. Defaults to false.

Returns

void

---

updateOrder()

updateOrder(): void

Defined in: workingtitle-instruments-epic2/shared/Components/List/Epic2List.tsx:275

Updates the order of rendered items in this list.

Returns

void