Interface: UiWaypointTouchButtonProps
Component props for UiWaypointTouchButton.
Hierarchy
Omit<UiTouchButtonProps,"label">↳
UiWaypointTouchButtonProps
Properties
canBeFocused
• Optional canBeFocused: boolean | Subscribable<boolean>
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:108
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
UiWaypointDisplayProps.children
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | ToggleableClassNameRecord | SubscribableSet<string>
CSS class(es) to apply to the button's root element.
Inherited from
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:114
dragThresholdPx
• Optional dragThresholdPx: number
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
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:156
focusController
• Optional focusController: UiFocusController
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:102
focusOnDrag
• Optional focusOnDrag: boolean
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:78
focusOptions
• Optional focusOptions: Readonly<UiTouchButtonFocusModuleOptions>
Options to configure the button's behavior related to UI focus.
Inherited from
Omit.focusOptions
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:111
gduFormat
• Optional gduFormat: GduFormat
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:96
hideRightInfo
• Optional hideRightInfo: boolean | Subscribable<boolean>
Whether to the hide the information displayed on the right side of the display. Defaults to false.
Inherited from
UiWaypointDisplayProps.hideRightInfo
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Waypoint/UiWaypointDisplay.tsx:25
inhibitOnDrag
• Optional inhibitOnDrag: boolean
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
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:150
inhibitOnDragAxis
• Optional inhibitOnDragAxis: "both" | "x" | "y"
The axis along which dragging will trigger the inhibit function. Ignored if inhibitOnDrag is false.
Defaults to 'both'.
Inherited from
Omit.inhibitOnDragAxis
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:162
isEnabled
• Optional isEnabled: boolean | Subscribable<boolean>
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
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:79
isHighlighted
• Optional isHighlighted: boolean | Subscribable<boolean>
Whether the button is highlighted, or a subscribable which provides it. Defaults to false.
Inherited from
Omit.isHighlighted
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:82
isInList
• Optional isInList: boolean
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:84
isVisible
• Optional isVisible: boolean | Subscribable<boolean>
Whether the button is visible. Defaults to true.
Inherited from
Omit.isVisible
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:85
listScrollAxis
• Optional listScrollAxis: "x" | "y"
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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:90
nullIdent
• Optional nullIdent: string | Subscribable<string>
The string to display in place of the ident when the displayed waypoint is null. Defaults to the empty string.
Inherited from
UiWaypointDisplayProps.nullIdent
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Waypoint/UiWaypointDisplay.tsx:19
nullLabel
• Optional nullLabel: string | Subscribable<string>
The label to display when the button's bound waypoint is null.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiWaypointTouchButton.tsx:16
nullName
• Optional nullName: string | Subscribable<string>
The string to display in place of the name when the displayed waypoint is null. Defaults to the empty string.
Inherited from
UiWaypointDisplayProps.nullName
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Waypoint/UiWaypointDisplay.tsx:22
onDestroy
• Optional onDestroy: () => void
A callback function which will be called when the button is destroyed.
Type declaration
▸ (): void
A callback function which will be called when the button is destroyed.
Returns
void
Inherited from
Omit.onDestroy
Defined in
src/garminsdk/components/touchbutton/TouchButton.tsx:165
onFocusGained
• Optional onFocusGained: <B>(button: B, direction: UiFocusDirection) => void
A function which is called when the button gains UI focus.
Param
The button that gained UI focus.
Type declaration
▸ <B>(button, direction): void
A function which is called when the button gains UI focus.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that gained UI focus. |
direction | UiFocusDirection | - |
Returns
void
Inherited from
Omit.onFocusGained
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:66
onFocusLost
• Optional onFocusLost: <B>(button: B) => void
A function which is called when the button loses UI focus.
Param
The button that lost UI focus.
Type declaration
▸ <B>(button): void
A function which is called when the button loses UI focus.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that lost UI focus. |
Returns
void
Inherited from
Omit.onFocusLost
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:72
onHoldEnded
• Optional onHoldEnded: <B>(button: B, totalHoldDuration: number, endReason: TouchButtonHoldEndReason) => void
A function which is called when the button exits the held state.
Param
The button that was held.
Param
The total amount of time, in milliseconds, that the button was held.
Param
The reason that the button exited the held state.
Type declaration
▸ <B>(button, totalHoldDuration, endReason): void
A function which is called when the button exits the held state.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:60
onHoldStarted
• Optional onHoldStarted: <B>(button: B) => TouchButtonHoldAction
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.
Param
The button that is held.
Type declaration
▸ <B>(button): TouchButtonHoldAction
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
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:40
onHoldTick
• Optional onHoldTick: <B>(button: B, dt: number, totalTime: number, timeSinceLastPress: number) => TouchButtonHoldAction
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.
Param
The button that is held.
Param
The elapsed time, in milliseconds, since the previous frame.
Param
The total amount of time, in milliseconds, that the button has been held.
Param
The amount of time, in milliseconds, that the button has been held since the last time the button was pressed as a tick action.
Type declaration
▸ <B>(button, dt, totalTime, timeSinceLastPress): TouchButtonHoldAction
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
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:52
onPressed
• Optional onPressed: <B>(button: B, isHeld: boolean) => void
A callback function which will be called every time the button is pressed.
Param
The button that was pressed.
Param
Whether the button was held when it was pressed.
Type declaration
▸ <B>(button, isHeld): void
A callback function which will be called every time the button is pressed.
Type parameters
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was pressed. |
isHeld | boolean | Whether the button was held when it was pressed. |
Returns
void
Inherited from
Omit.onPressed
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:32
onTouched
• Optional onTouched: <B>(button: B) => TouchButtonOnTouchedAction
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.
Param
The button that was touched.
Type declaration
▸ <B>(button): TouchButtonOnTouchedAction
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
| Name | Type |
|---|---|
B | extends UiTouchButton = UiTouchButton |
Parameters
| Name | 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
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/TouchButton/UiTouchButton.tsx:25
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
waypoint
• waypoint: null | FacilityWaypoint<Facility> | Subscribable<null | FacilityWaypoint<Facility>>
The waypoint to display.
Inherited from
UiWaypointDisplayProps.waypoint
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/Components/Waypoint/UiWaypointDisplay.tsx:16