Interface: GtcDesignatedPaneButtonProps

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:11

Component props for GtcDesignatedPaneButton.

Extends

• Omit<GtcTouchButtonProps, "label" | "onPressed">

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

Omit.children

---

class?

optional class: string | SubscribableSet<string>

Defined in: garminsdk/components/touchbutton/TouchButton.tsx:168

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

Inherited from

Omit.class

---

displayPaneSettingManager

displayPaneSettingManager: UserSettingManager<DisplayPaneSettings>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:13

A manager of display pane settings for the display pane controlled by the button.

---

dragThresholdPx?

optional dragThresholdPx: number

Defined in: 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

---

focusOnDrag?

optional focusOnDrag: boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcTouchButton.tsx:16

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

---

getPaneViewKeyToDesignate()?

optional getPaneViewKeyToDesignate: () => string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:44

A function which gets the key of the display pane view to set as the designated and displayed pane view when the button is pressed and not considered to be selected. Ignored if onPressed is defined.

Returns

string

---

gtcOrientation?

optional gtcOrientation: GtcOrientation

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcTouchButton.tsx:34

The orientation of the button's parent GTC. Used to set the button's inhibit on drag threshold unless otherwise specified by the dragThresholdPx prop. Defaults to 'horizontal'.

Inherited from

Omit.gtcOrientation

---

imgSrc?

optional imgSrc: string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:25

The src of the button's image when not selected. Also defines the src when selected if selectedImgSrc is not defined.

---

inhibitOnDrag?

optional inhibitOnDrag: boolean

Defined in: 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: 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: 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: 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: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcTouchButton.tsx:22

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: garminsdk/components/touchbutton/TouchButton.tsx:85

Whether the button is visible. Defaults to true.

Inherited from

Omit.isVisible

---

label?

optional label: string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:22

The button's label when not selected. Also defines the label when selected if selectedLabel is not defined.

---

listScrollAxis?

optional listScrollAxis: "x" | "y"

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcTouchButton.tsx:28

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

---

onDestroy()?

optional onDestroy: () => void

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

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

Returns

void

Inherited from

Omit.onDestroy

---

onHoldEnded()?

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

Defined in: garminsdk/components/touchbutton/TouchButton.tsx:137

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

Type Parameters

Type Parameter	Default type
B extends TouchButton<TouchButtonProps>	TouchButton<TouchButtonProps>

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: garminsdk/components/touchbutton/TouchButton.tsx:117

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 TouchButton<TouchButtonProps>	TouchButton<TouchButtonProps>

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: garminsdk/components/touchbutton/TouchButton.tsx:129

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 TouchButton<TouchButtonProps>	TouchButton<TouchButtonProps>

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

---

onPressed()?

optional onPressed: (isSelected, button) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:38

A callback function which will be called every time the button is pressed. If not defined and getPaneViewKeyToSelect is defined, the button will set the designated pane view and the displayed pane view to the one returned by getPaneViewKeyToSelect when pressed and not selected.

Parameters

Parameter	Type
isSelected	boolean
button	GtcDesignatedPaneButton

Returns

void

---

onPressedSelected()?

optional onPressedSelected: (button) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:50

A call back function which will be called every time the button is pressed and considered to be selected. Ignored if onPressed is defined.

Parameters

Parameter	Type
button	GtcDesignatedPaneButton

Returns

void

---

onTouched()?

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

Defined in: garminsdk/components/touchbutton/TouchButton.tsx:102

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 entering the primed state when touched.

Type Parameters

Type Parameter	Default type
B extends TouchButton<TouchButtonProps>	TouchButton<TouchButtonProps>

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: sdk/components/FSComponent.ts:125

A reference to the display component.

Inherited from

Omit.ref

---

selectedImgSrc?

optional selectedImgSrc: string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:31

The src of the button's image when selected. Defaults to the unselected image src.

---

selectedLabel?

optional selectedLabel: string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:28

The button's label when selected. Defaults to the unselected label.

---

selectedPaneViewKeys

selectedPaneViewKeys: Iterable<string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:19

An iterable of keys for display pane views that, when set as the designated pane view for the button's display pane, marks the button as selected.