Class: TouchPad<P>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:129

A touchscreen pad which tracks mouse drag motions.

Extends

• DisplayComponent<P>

Type Parameters

Type Parameter	Default type
P extends TouchPadProps	TouchPadProps

Constructors

Constructor

new TouchPad<P>(props): TouchPad<P>

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	P	The propertis of the component.

Returns

TouchPad<P>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

cssClassSub?

protected optional cssClassSub: Subscription

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:190

---

currentMousePosition

protected readonly currentMousePosition: Float64Array<ArrayBufferLike>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:160

---

dragInhibitThresholdPx

protected readonly dragInhibitThresholdPx: number

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:168

---

dragLockFocusThresholdPx

protected readonly dragLockFocusThresholdPx: number

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:165

---

focusOnDrag

protected readonly focusOnDrag: boolean

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:162

---

inhibitOnDrag

protected readonly inhibitOnDrag: boolean

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:166

---

inhibitOnDragAxis

protected readonly inhibitOnDragAxis: "both" | "x" | "y"

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:167

---

instrumentMouseLeaveSub?

protected optional instrumentMouseLeaveSub: Subscription

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:193

---

isEnabled

protected readonly isEnabled: Subscribable<boolean> | Subscribable<false> | Subscribable<true>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:152

---

isEnabledSub?

protected optional isEnabledSub: Subscription

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:191

---

isFocusLocked

protected isFocusLocked: boolean = false

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:156

---

isPrimed

protected isPrimed: boolean = false

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:155

---

isVisible

protected readonly isVisible: Subscribable<boolean> | Subscribable<false> | Subscribable<true>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:153

---

isVisibleSub?

protected optional isVisibleSub: Subscription

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:192

---

lastTickMousePosition

protected readonly lastTickMousePosition: Float64Array<ArrayBufferLike>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:172

---

lastTickTime

protected lastTickTime: undefined | number = undefined

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:171

---

lockFocusOnDrag

protected readonly lockFocusOnDrag: boolean

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:163

---

lockFocusOnDragAxis

protected readonly lockFocusOnDragAxis: "both" | "x" | "y"

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:164

---

mouseDownListener()

protected readonly mouseDownListener: (e) => void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:147

Responds to mouse down events on this pad's root element.

Parameters

Parameter	Type	Description
e	MouseEvent	The mouse event.

Returns

void

---

mouseDownPosition

protected readonly mouseDownPosition: Float64Array<ArrayBufferLike>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:158

---

mouseLeaveListener()

protected readonly mouseLeaveListener: (e?) => void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:149

Responds to mouse leave events.

Parameters

Parameter	Type	Description
e?	MouseEvent	The mouse event, or undefined if the mouse left the instrument window.

Returns

void

---

mouseMoveListener()

protected readonly mouseMoveListener: (e) => void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:150

Responds to mouse move events.

Parameters

Parameter	Type	Description
e	MouseEvent	The mouse event.

Returns

void

---

mouseUpListener()

protected readonly mouseUpListener: () => void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:148

Responds to mouse up events.

Returns

void

---

prevMousePosition

protected readonly prevMousePosition: Float64Array<ArrayBufferLike>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:159

---

props

props: P & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

---

rootCssClass

protected readonly rootCssClass: SetSubject<string>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:145

---

rootRef

protected readonly rootRef: NodeReference<HTMLDivElement>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:141

---

sliderContainerRef

protected readonly sliderContainerRef: NodeReference<HTMLDivElement>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:142

---

sliderThumbRef

protected readonly sliderThumbRef: NodeReference<HTMLDivElement>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:143

---

tickInterval

protected tickInterval: null | Timeout = null

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:170

---

DEFAULT_SNAP_ANIMATION_EASING()

protected readonly static DEFAULT_SNAP_ANIMATION_EASING: (start, stop, progress) => number

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:132

Parameters

Parameter	Type
start	number
stop	number
progress	number

Returns

number

---

RESERVED_CSS_CLASSES

protected readonly static RESERVED_CSS_CLASSES: Set<string>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:134

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:418

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(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

DisplayComponent.getContext

---

getDragDistance()

protected getDragDistance(axis, initialPos): number

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:379

Get the distance that the mouse has been dragged along an axis relative to an initial position.

Parameters

Parameter	Type	Description
axis	"both" | "x" | "y"	The axis along which to measure the distance.
initialPos	ReadonlyFloat64Array	The initial mouse position.

Returns

number

The distance that the mouse has been dragged along the specified axis relative to the specified initial position.

---

getReservedCssClasses()

protected getReservedCssClasses(): ReadonlySet<string>

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:413

Gets the CSS classes that are reserved for this pad's root element.

Returns

ReadonlySet<string>

The CSS classes that are reserved for this pad's root element.

---

onAfterRender()

onAfterRender(node): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:197

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

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

DisplayComponent.onBeforeRender

---

onMouseDown()

protected onMouseDown(e): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:287

Responds to mouse down events on this pad's root element.

Parameters

Parameter	Type	Description
e	MouseEvent	The mouse event.

Returns

void

---

onMouseLeave()

protected onMouseLeave(e?): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:312

Responds to mouse leave events.

Parameters

Parameter	Type	Description
e?	MouseEvent	The mouse event, or undefined if the mouse left the instrument window.

Returns

void

---

onMouseMove()

protected onMouseMove(e): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:338

Responds to mouse move events.

Parameters

Parameter	Type	Description
e	MouseEvent	The mouse event.

Returns

void

---

onMouseUp()

protected onMouseUp(): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:304

Responds to mouse up events.

Returns

void

---

render()

render(): VNode

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:391

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

setFocusLocked()

protected setFocusLocked(isFocusLocked): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:268

Sets the focus lock state of this pad.

Parameters

Parameter	Type	Description
isFocusLocked	boolean	The new focus lock state.

Returns

void

---

setPrimed()

protected setPrimed(isPrimed): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:232

Sets the primed state of this pad.

Parameters

Parameter	Type	Description
isPrimed	boolean	The new primed state.

Returns

void

---

tickFunc()

protected readonly tickFunc(): void

Defined in: src/garminsdk/components/touchpad/TouchPad.tsx:174

Returns

void