Class: TouchList
Defined in: src/garminsdk/components/list/TouchList.tsx:19
A touchscreen list which can be scrolled by clicking and dragging the mouse.
Extends
Constructors
Constructor
new TouchList(
props):TouchList
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
| Parameter | Type | Description |
|---|---|---|
props | TouchListProps | The propertis of the component. |
Returns
TouchList
Inherited from
Properties
_animationTargetScrollPos
protectedreadonly_animationTargetScrollPos:Subject<undefined|number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:185
Inherited from
ScrollList._animationTargetScrollPos
_firstVisibleIndex
protectedreadonly_firstVisibleIndex:MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:202
Inherited from
_itemsPerPage
protectedreadonly_itemsPerPage:undefined|Subject<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:75
Inherited from
_lengthPx
protectedreadonly_lengthPx:Subscribable<number> |MappedSubscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:103
Inherited from
_listItemLengthWithMarginPx
protectedreadonly_listItemLengthWithMarginPx:MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:84
Inherited from
ScrollList._listItemLengthWithMarginPx
_maxScrollPos
protectedreadonly_maxScrollPos:MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:129
Inherited from
_renderWindow
protectedreadonly_renderWindow:Vec2Subject
Defined in: src/garminsdk/components/list/ScrollList.tsx:234
Inherited from
_scrollPos
protectedreadonly_scrollPos:Subject<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:142
Inherited from
_totalLengthPx
protectedreadonly_totalLengthPx:MappedSubject<[number,number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:92
Inherited from
animateFunc()
protectedreadonlyanimateFunc: () =>void
Defined in: src/garminsdk/components/list/ScrollList.tsx:241
Called once per animation frame while we are animating.
Returns
void
Inherited from
animationTargetScrollPos
readonlyanimationTargetScrollPos:Subscribable<undefined|number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:190
The scroll position targeted by this list's current scrolling animation, in pixels, or undefined if scrolling is
not currently animated or the animation has no defined target scroll position.
Inherited from
ScrollList.animationTargetScrollPos
childrenNode?
protectedoptionalchildrenNode:VNode
Defined in: src/garminsdk/components/list/ScrollList.tsx:58
Inherited from
context?
optionalcontext: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
contextType?
readonlyoptionalcontextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
cssClassSub?
protectedoptionalcssClassSub:Subscription|Subscription[]
Defined in: src/garminsdk/components/list/ScrollList.tsx:257
Inherited from
deltaTimeSeconds
protecteddeltaTimeSeconds:number=0
Defined in: src/garminsdk/components/list/ScrollList.tsx:246
Inherited from
firstVisibleIndex
readonlyfirstVisibleIndex:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:210
Inherited from
goToAnimationTargetPos
protectedgoToAnimationTargetPos:boolean=false
Defined in: src/garminsdk/components/list/ScrollList.tsx:252
Inherited from
ScrollList.goToAnimationTargetPos
instrumentMouseLeaveSub
protectedreadonlyinstrumentMouseLeaveSub:undefined|Subscription
Defined in: src/garminsdk/components/list/TouchList.tsx:24
interval?
protectedoptionalinterval:number
Defined in: src/garminsdk/components/list/ScrollList.tsx:253
Inherited from
isAnimating
protectedisAnimating:boolean=false
Defined in: src/garminsdk/components/list/ScrollList.tsx:243
Inherited from
isMouseDown
protectedreadonlyisMouseDown:Subject<boolean>
Defined in: src/garminsdk/components/list/TouchList.tsx:22
itemCount
protectedreadonlyitemCount:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:70
Inherited from
itemsContainerRef
protectedreadonlyitemsContainerRef:NodeReference<HTMLDivElement>
Defined in: src/garminsdk/components/list/ScrollList.tsx:62
Inherited from
itemsPerPage
readonlyitemsPerPage:undefined|Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:80
The number of visible list items per page displayed by this list, or undefined if the number of items per page
is not prescribed.
Inherited from
itemsPerPageProp
protectedreadonlyitemsPerPageProp:undefined|Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:66
Inherited from
lastMousePosition
protectedlastMousePosition:undefined|number=undefined
Defined in: src/garminsdk/components/list/TouchList.tsx:27
lastTimeSeconds
protectedlastTimeSeconds:number=0
Defined in: src/garminsdk/components/list/ScrollList.tsx:245
Inherited from
lengthPx
readonlylengthPx:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:116
The visible length of this list, in pixels, along its scroll axis.
Inherited from
listItemLengthPx
protectedreadonlylistItemLengthPx:Subject<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:68
Inherited from
listItemLengthPxProp
protectedreadonlylistItemLengthPxProp:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:64
Inherited from
ScrollList.listItemLengthPxProp
listItemLengthWithMarginPx
readonlylistItemLengthWithMarginPx:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:90
The length, in pixels, of one item in this list plus its margin along this list's scroll axis.
Inherited from
ScrollList.listItemLengthWithMarginPx
listItemParamSubs
protectedreadonlylistItemParamSubs:Subscription[] =[]
Defined in: src/garminsdk/components/list/ScrollList.tsx:255
Inherited from
listItemSpacingPx
protectedreadonlylistItemSpacingPx:Subject<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:69
Inherited from
listItemSpacingPxProp
protectedreadonlylistItemSpacingPxProp:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:65
Inherited from
ScrollList.listItemSpacingPxProp
maxOverscrollPx
protectedreadonlymaxOverscrollPx:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:140
How many pixels we will allow overscrolling before stopping.
Inherited from
maxRenderedItemCount
protectedreadonlymaxRenderedItemCount:undefined|MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:212
Inherited from
ScrollList.maxRenderedItemCount
maxScrollPos
readonlymaxScrollPos:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:137
This list's maximum allowed scroll position, in pixels. Does not include overscroll.
Inherited from
maxTimeInOverscrollSeconds
protectedmaxTimeInOverscrollSeconds:number=0.5
Defined in: src/garminsdk/components/list/ScrollList.tsx:249
How long to wait while overscrolled before snapping back.
Inherited from
ScrollList.maxTimeInOverscrollSeconds
onMouseDownCaptureFunc()
protectedreadonlyonMouseDownCaptureFunc: (e) =>void
Defined in: src/garminsdk/components/list/TouchList.tsx:29
User has clicked on the list, so now we want to listen for the mouse moving so we can scroll the list with the mouse.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseDownFunc()
protectedreadonlyonMouseDownFunc: (e) =>void
Defined in: src/garminsdk/components/list/TouchList.tsx:30
User has clicked on the list, so now we want to listen for the mouse moving so we can scroll the list with the mouse.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseMoveFunc()
protectedreadonlyonMouseMoveFunc: (e) =>void
Defined in: src/garminsdk/components/list/TouchList.tsx:32
Responds to mousemove events on this list while the user is dragging.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseUpFunc()
protectedreadonlyonMouseUpFunc: () =>void
Defined in: src/garminsdk/components/list/TouchList.tsx:31
Responds to mouseup events on this list after the user has started dragging.
Returns
void
pageLength
protectedreadonlypageLength:MappedSubscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:119
The length of one page, in pixels, along this list's scroll axis.
Inherited from
props
props:
TouchListProps&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
renderWindow
readonlyrenderWindow:Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>,"set"|"sort"|"copyWithin">>>
Defined in: src/garminsdk/components/list/ScrollList.tsx:239
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.
Inherited from
renderWindowStartIndex
protectedreadonlyrenderWindowStartIndex:Subject<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:220
Inherited from
ScrollList.renderWindowStartIndex
renderWindowStartPos
protectedreadonlyrenderWindowStartPos:MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:221
Inherited from
ScrollList.renderWindowStartPos
rootRef
protectedreadonlyrootRef:NodeReference<HTMLDivElement>
Defined in: src/garminsdk/components/list/ScrollList.tsx:60
Inherited from
scrollAxis
readonlyscrollAxis:"x"|"y"
Defined in: src/garminsdk/components/list/ScrollList.tsx:73
The axis along which this list scrolls.
Inherited from
scrollBarLengthFraction
readonlyscrollBarLengthFraction:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:177
The fraction of this list's visible length compared to the total length of all items in this list plus their margins along this list's scroll axis.
Inherited from
ScrollList.scrollBarLengthFraction
scrollPos
readonlyscrollPos:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:147
This list's current scroll position, in pixels. The scroll position is zero when the list is scrolled to the beginning (without overscroll) and increases as the list is scrolled toward the end.
Inherited from
scrollPosFraction
readonlyscrollPosFraction:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:153
This list's current scroll position, normalized such that 0 represents when the list is scrolled to the beginning (without overscroll) and 1 represents when the list is scrolled to the end (without overscroll).
Inherited from
snappingTransitionSpeed
protectedsnappingTransitionSpeed:number=200
Defined in: src/garminsdk/components/list/ScrollList.tsx:251
Once at or below this velocity, we pick that target Y to snap to.
Inherited from
ScrollList.snappingTransitionSpeed
snapToItem
protectedreadonlysnapToItem:boolean
Defined in: src/garminsdk/components/list/ScrollList.tsx:82
Inherited from
targetScrollPos
readonlytargetScrollPos:MappedSubject<[undefined|number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:196
This list's current target scroll position, in pixels. The target scroll position is equal to the current animation target if it is defined; otherwise it is equal to the current scroll position.
Inherited from
timeInOverscrollSeconds
protectedtimeInOverscrollSeconds:number=0
Defined in: src/garminsdk/components/list/ScrollList.tsx:247
Inherited from
ScrollList.timeInOverscrollSeconds
totalLengthPx
readonlytotalLengthPx:Subscribable<number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:101
The total length, in pixels, of all items in this list plus their margins along this list's scroll axis.
Inherited from
translatableRef
protectedreadonlytranslatableRef:NodeReference<HTMLDivElement>
Defined in: src/garminsdk/components/list/ScrollList.tsx:61
Inherited from
trueScrollPos
protectedreadonlytrueScrollPos:MappedSubject<[number,number],number>
Defined in: src/garminsdk/components/list/ScrollList.tsx:228
This list's current scroll position adjusted for the render window.
Inherited from
velocity
protectedvelocity:number=0
Defined in: src/garminsdk/components/list/ScrollList.tsx:244
Inherited from
RESERVED_CLASSES
protectedreadonlystaticRESERVED_CLASSES:string[]
Defined in: src/garminsdk/components/list/TouchList.tsx:20
Overrides
Methods
animate()
protectedanimate():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:488
Called once per animation frame while we are animating.
Returns
void
Inherited from
animateSnapback()
protectedanimateSnapback():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:557
Animates scrolling back when overscrolled.
Returns
void
Inherited from
animateSnapping()
protectedanimateSnapping(deltaTimeSeconds):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:588
If we have a target Y position to stop scrolling at, animate towards a smooth stop right at that point.
Parameters
| Parameter | Type | Description |
|---|---|---|
deltaTimeSeconds | number | Seconds since last animation frame. |
Returns
void
Inherited from
animateVelocity()
protectedanimateVelocity(deltaTimeSeconds):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:532
Applies the velocity to the scroll position, which gives it the "flick" effect. Also slows the velocity down overtime.
Parameters
| Parameter | Type | Description |
|---|---|---|
deltaTimeSeconds | number | Seconds since last animation frame. |
Returns
void
Inherited from
changeRenderWindow()
protectedchangeRenderWindow(scrollPos,renderCount,itemLength,windowLength):void
Defined in: src/garminsdk/components/list/TouchList.tsx:100
Changes this list's item render window.
Parameters
| Parameter | Type | Description |
|---|---|---|
scrollPos | number | The scroll position on which to center the new render window, in pixels. |
renderCount | number | The number of items to render in the new window. |
itemLength | number | The length of each item to render, including margin, in pixels. |
windowLength | number | The length of the render window, in pixels. |
Returns
void
Overrides
destroy()
destroy():
void
Defined in: src/garminsdk/components/list/TouchList.tsx:193
Destroys this component.
Returns
void
Overrides
ensureScrollIsInBounds()
protectedensureScrollIsInBounds():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:766
Checks if the list is scrolled past the maximum limit, and if so, snaps the list back to the limit.
Returns
void
Inherited from
ScrollList.ensureScrollIsInBounds
executeScrollTo()
protectedexecuteScrollTo(pos,animate):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:449
Executes a scroll to a specifed position.
Parameters
| Parameter | Type | Description |
|---|---|---|
pos | number | The position to which to scroll. |
animate | boolean | Whether to animate the scroll. |
Returns
void
Inherited from
getContainerRef()
getContainerRef():
HTMLDivElement
Defined in: src/garminsdk/components/list/ScrollList.tsx:306
Returns a reference to the element where the list items should be added.
Returns
HTMLDivElement
A reference to the element where the list items should be added.
Inherited from
getContext()
protectedgetContext(context):never
Defined in: src/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
getDampening()
protectedgetDampening(direction):number
Defined in: src/garminsdk/components/list/ScrollList.tsx:782
Returns a number used to dampen the mouse movement when overscrolled.
Parameters
| Parameter | Type | Description |
|---|---|---|
direction | number | What direction os the mouse moving in. |
Returns
number
a number used to dampen the mouse movement when overscrolled.
Inherited from
getOverscrollPx()
protectedgetOverscrollPx():number
Defined in: src/garminsdk/components/list/ScrollList.tsx:814
Gets the distance by which this list is currently overscrolled, in pixels along the scroll axis.
Returns
number
The distance by which this list is currently overscrolled, in pixels along the scroll axis.
Inherited from
getReservedCssClasses()
protectedgetReservedCssClasses(): readonlystring[]
Defined in: src/garminsdk/components/list/TouchList.tsx:188
Gets an array of this list's reserved CSS classes.
Returns
readonly string[]
An array of this list's reserved CSS classes.
Overrides
ScrollList.getReservedCssClasses
isOverscrolled()
protectedisOverscrolled():boolean
Defined in: src/garminsdk/components/list/ScrollList.tsx:828
Returns whether this list is currently overscrolled.
Returns
boolean
Whether this list is currently overscrolled.
Inherited from
onAfterRender()
onAfterRender():
void
Defined in: src/garminsdk/components/list/TouchList.tsx:35
A callback that is called after the component is rendered.
Returns
void
Overrides
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
onListItemParamChanged()
protectedonListItemParamChanged(pipeTo,value):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:694
Responds to when one of this list's item parameters changes when the list supports snapping to items.
Parameters
| Parameter | Type | Description |
|---|---|---|
pipeTo | MutableSubscribable<number> | The mutable subscribable to which to pipe the new parameter value. |
value | number | The new parameter value. |
Returns
void
Inherited from
ScrollList.onListItemParamChanged
onMouseDown()
protectedonMouseDown(e):void
Defined in: src/garminsdk/components/list/TouchList.tsx:130
User has clicked on the list, so now we want to listen for the mouse moving so we can scroll the list with the mouse.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseDownCapture()
protectedonMouseDownCapture(e):void
Defined in: src/garminsdk/components/list/TouchList.tsx:113
User has clicked on the list, so now we want to listen for the mouse moving so we can scroll the list with the mouse.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseMove()
protectedonMouseMove(e):void
Defined in: src/garminsdk/components/list/TouchList.tsx:160
Responds to mousemove events on this list while the user is dragging.
Parameters
| Parameter | Type | Description |
|---|---|---|
e | MouseEvent | The mouse event. |
Returns
void
onMouseUp()
protectedonMouseUp():void
Defined in: src/garminsdk/components/list/TouchList.tsx:143
Responds to mouseup events on this list after the user has started dragging.
Returns
void
pageBack()
pageBack():
void
Defined in: src/garminsdk/components/list/ScrollList.tsx:313
Scrolls backward by one full page length.
Returns
void
Inherited from
pageForward()
pageForward():
void
Defined in: src/garminsdk/components/list/ScrollList.tsx:328
Scrolls forward by one full page length.
Returns
void
Inherited from
pickNearestSnapToPos()
protectedpickNearestSnapToPos(pos):number
Defined in: src/garminsdk/components/list/ScrollList.tsx:685
Picks the scroll position, in pixels, of the snap-to target that is nearest to a given scroll position.
Parameters
| Parameter | Type | Description |
|---|---|---|
pos | number | The scroll position, in pixels, for which to find the nearest snap-to target. |
Returns
number
The scroll position, in pixels, of the snap-to target that is nearest to the specified scroll position.
Inherited from
ScrollList.pickNearestSnapToPos
render()
render():
VNode
Defined in: src/garminsdk/components/list/ScrollList.tsx:833
Renders the component.
Returns
A JSX element to be rendered.
Inherited from
scrollToIndex()
scrollToIndex(
index,position,animate):void
Defined in: src/garminsdk/components/list/TouchList.tsx:69
Scrolls until the item at a specified index is in view. The operation will be aborted if the list is currently being dragged by the user.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the item to which to scroll. |
position | number | The position to place the target item at the end of the scroll. Position 0 is the top/left-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. Negative values will be interpreted as counting backwards from the bottom/right-most visible slot starting with -1. Ignored if this list does not support snapping to list items. |
animate | boolean | Whether to animate the scroll. |
Returns
void
Overrides
scrollToIndexWithMargin()
scrollToIndexWithMargin(
index,margin,animate):void
Defined in: src/garminsdk/components/list/TouchList.tsx:90
Scrolls the minimum possible distance until the item at a specified index is in view with a given margin from the edges of the visible list. The operation will be aborted if the list is currently being dragged by the user.
Parameters
| Parameter | Type | Description |
|---|---|---|
index | number | The index of the item to which to scroll. |
margin | number | The margin from the edges of the visible list to respect when scrolling to the target item. In other words, the scrolling operation will attempt to place the target item at least as far from the edges of the visible list as the specified margin. If this list supports snapping to items, then the margin should be expressed as an item count. If this list does not support snapping to items, then the margin should be expressed as pixels. The margin will be clamped between zero and the largest possible value such that an item can be placed within the visible list while respecting the margin value on both sides. |
animate | boolean | Whether to animate the scroll. |
Returns
void
Overrides
ScrollList.scrollToIndexWithMargin
startAnimating()
protectedstartAnimating():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:466
Reset the animation vars and start the animation, if not already started.
Returns
void
Inherited from
stopAnimating()
protectedstopAnimating():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:478
Stop the animation.
Returns
void
Inherited from
updateRenderWindow()
protectedupdateRenderWindow():void
Defined in: src/garminsdk/components/list/ScrollList.tsx:709
Updates this list's item render window.
Returns
void
Inherited from
updateTransformX()
protectedupdateTransformX(scrollPos):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:751
Updates this list's item container's x-transform based on the current true scroll position.
Parameters
| Parameter | Type | Description |
|---|---|---|
scrollPos | number | The current true scroll position, in pixels. |
Returns
void
Inherited from
updateTransformY()
protectedupdateTransformY(scrollPos):void
Defined in: src/garminsdk/components/list/ScrollList.tsx:759
Updates this list's item container's y-transform based on the current true scroll position.
Parameters
| Parameter | Type | Description |
|---|---|---|
scrollPos | number | The current true scroll position, in pixels. |
Returns
void