Interface: UiWaypointSelectButtonProps<T, S>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:17

Component props for UiWaypointSelectButton.

Extends

• Omit<UiWaypointTouchButtonProps, "waypoint" | "onPressed" | "gtcOrientation">

Type Parameters

Type Parameter
T extends G3XWaypointSearchType
S extends Subscribable<G3XWaypointSearchTypeMap[T] | null>

Properties

canBeFocused?

optional canBeFocused: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:108

Whether the button can be focused. Irrespective of this value, the button cannot be focused while it is disabled or not visible. Defaults to true.

Inherited from

Omit.canBeFocused

---

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

Omit.children

---

class?

optional class: string | ToggleableClassNameRecord | SubscribableSet<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:114

CSS class(es) to apply to the button's root element.

Inherited from

Omit.class

---

dragThresholdPx?

optional dragThresholdPx: number

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:156

The distance, in pixels, the mouse can click and drag before the pad begins to ignore mouse events. Ignored if inhibitOnDrag is false. Defaults to 40 pixels.

Inherited from

Omit.dragThresholdPx

---

focusController?

optional focusController: UiFocusController

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:102

A UI focus controller with which to automatically register the button after it is rendered. If not defined, then the button will not be automatically registered with any controller, but it may still be registered manually.

Inherited from

Omit.focusController

---

focusOnDrag?

optional focusOnDrag: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:78

Whether the pad should focus all mouse events when dragging, preventing them from bubbling up to any ancestors in the DOM tree. Defaults to true.

Inherited from

Omit.focusOnDrag

---

focusOptions?

optional focusOptions: Readonly<UiTouchButtonFocusModuleOptions>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:111

Options to configure the button's behavior related to UI focus.

Inherited from

Omit.focusOptions

---

gduFormat?

optional gduFormat: GduFormat

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:96

The format of the button's parent GDU display. Used to set the button's inhibit on drag threshold unless otherwise specified by the dragThresholdPx prop. Defaults to '460'.

Inherited from

Omit.gduFormat

---

hideRightInfo?

optional hideRightInfo: boolean | Subscribable<boolean>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Waypoint/UiWaypointDisplay.tsx:25

Whether to the hide the information displayed on the right side of the display. Defaults to false.

Inherited from

Omit.hideRightInfo

---

inhibitOnDrag?

optional inhibitOnDrag: boolean

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:150

Whether the button should stop responding to mouse events and instead forward them to its parent after clicking and dragging for a certain distance defined by dragThresholdPx along the axis defined by inhibitOnDragAxis. When mouse events are inhibited, the button cannot be primed or held. Defaults to false.

Inherited from

Omit.inhibitOnDrag

---

inhibitOnDragAxis?

optional inhibitOnDragAxis: "both" | "x" | "y"

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:162

The axis along which dragging will trigger the inhibit function. Ignored if inhibitOnDrag is false. Defaults to 'both'.

Inherited from

Omit.inhibitOnDragAxis

---

isEnabled?

optional isEnabled: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:79

Whether the button is enabled, or a subscribable which provides it. Disabled buttons cannot be touched, primed, pressed, or held. Defaults to true.

Inherited from

Omit.isEnabled

---

isHighlighted?

optional isHighlighted: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:82

Whether the button is highlighted, or a subscribable which provides it. Defaults to false.

Inherited from

Omit.isHighlighted

---

isInList?

optional isInList: boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:84

Whether the button is in a scrollable list. If true, will enable the inhibit on drag function unless otherwise specified by the inhibitOnDrag prop. Defaults to false.

Inherited from

Omit.isInList

---

isVisible?

optional isVisible: boolean | Subscribable<boolean>

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:85

Whether the button is visible. Defaults to true.

Inherited from

Omit.isVisible

---

listScrollAxis?

optional listScrollAxis: "x" | "y"

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:90

The scroll axis of the button's parent list. Ignored if isInList is false. Sets the button's inhibit on drag axis unless otherwise specified by the inhibitOnDragAxis prop. Defaults to y.

Inherited from

Omit.listScrollAxis

---

nullIdent?

optional nullIdent: string | Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Waypoint/UiWaypointDisplay.tsx:19

The string to display in place of the ident when the displayed waypoint is null. Defaults to the empty string.

Inherited from

Omit.nullIdent

---

nullLabel?

optional nullLabel: string | Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:16

The label to display when the button's bound waypoint is null.

Inherited from

Omit.nullLabel

---

nullName?

optional nullName: string | Subscribable<string>

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/Waypoint/UiWaypointDisplay.tsx:22

The string to display in place of the name when the displayed waypoint is null. Defaults to the empty string.

Inherited from

Omit.nullName

---

onCancelled()?

optional onCancelled: <B>(waypointState, button) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:50

A callback function which will be called every time a waypoint selection from the button is cancelled.

Type Parameters

Type Parameter	Default type
B extends UiWaypointSelectButton<T, S>	UiWaypointSelectButton<T, S>

Parameters

Parameter	Type	Description
waypointState	S	The waypoint state bound to the button.
button	B	The button used to initiate the selection that was cancelled.

Returns

void

---

onDestroy()?

optional onDestroy: () => void

Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:165

A callback function which will be called when the button is destroyed.

Returns

void

Inherited from

Omit.onDestroy

---

onFocusGained()?

optional onFocusGained: <B>(button, direction) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:66

A function which is called when the button gains UI focus.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that gained UI focus.
direction	UiFocusDirection	-

Returns

void

Inherited from

Omit.onFocusGained

---

onFocusLost()?

optional onFocusLost: <B>(button) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:72

A function which is called when the button loses UI focus.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that lost UI focus.

Returns

void

Inherited from

Omit.onFocusLost

---

onHoldEnded()?

optional onHoldEnded: <B>(button, totalHoldDuration, endReason) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:60

A function which is called when the button exits the held state.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that was held.
totalHoldDuration	number	The total amount of time, in milliseconds, that the button was held.
endReason	TouchButtonHoldEndReason	The reason that the button exited the held state.

Returns

void

Inherited from

Omit.onHoldEnded

---

onHoldStarted()?

optional onHoldStarted: <B>(button) => TouchButtonHoldAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:40

A function which is called when the button enters the held state. If not defined, then the button will default to taking no specific action when it enters the held state.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that is held.

Returns

TouchButtonHoldAction

The action to take. Ignored if the value is equal to TouchButtonHoldAction.EndHold.

Inherited from

Omit.onHoldStarted

---

onHoldTick()?

optional onHoldTick: <B>(button, dt, totalTime, timeSinceLastPress) => TouchButtonHoldAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:52

A function which is called every frame when the button is held. If not defined, then the button will default to taking no specific action with each frame tick.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that is held.
dt	number	The elapsed time, in milliseconds, since the previous frame.
totalTime	number	The total amount of time, in milliseconds, that the button has been held.
timeSinceLastPress	number	The amount of time, in milliseconds, that the button has been held since the last time the button was pressed as a tick action.

Returns

TouchButtonHoldAction

The action to take.

Inherited from

Omit.onHoldTick

---

onSelected()?

optional onSelected: <B>(selectedWaypoint, waypointState, button) => void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:39

A callback function which will be called every time a value is selected from the list. If not defined and the button's bound waypoint state is a mutable subscribable, the bound state will be set to the selected waypoint.

Type Parameters

Type Parameter	Default type
B extends UiWaypointSelectButton<T, S>	UiWaypointSelectButton<T, S>

Parameters

Parameter	Type	Description
selectedWaypoint	G3XWaypointSearchTypeMap[T]	The waypoint that was selected.
waypointState	S	The waypoint state bound to the button.
button	B	The button used to initiate the selection.

Returns

void

---

onTouched()?

optional onTouched: <B>(button) => TouchButtonOnTouchedAction

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiTouchButton.tsx:25

A callback function which will be called every time the button is touched (i.e. a mouse down event on the button is detected). If not defined, then the button will default to attempting to set focus on its focus module and entering the primed state when touched.

Type Parameters

Type Parameter	Default type
B extends UiTouchButton	UiTouchButton

Parameters

Parameter	Type	Description
button	B	The button that was touched.

Returns

TouchButtonOnTouchedAction

The action to take as a result of the button being touched.

Inherited from

Omit.onTouched

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

Omit.ref

---

type

type: T

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:24

The type of facility allowed to be selected by the button.

---

uiService

uiService: UiService

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:21

The UI service instance.

---

waypoint

waypoint: S

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:27

The waypoint state bound to the button.

---

waypointCache

waypointCache: GarminFacilityWaypointCache

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiWaypointSelectButton.tsx:30

A cache used by the button to retrieve waypoints for facilities.