Skip to main content

Interface: GtcDesignatedPaneButtonProps

Component props for GtcDesignatedPaneButton.

Hierarchy

Properties

children

Optional children: DisplayChildren[]

The children of the display component.

Inherited from

Omit.children

Defined in

sdk/components/FSComponent.ts:122


class

Optional class: string | SubscribableSet<string>

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

Inherited from

Omit.class

Defined in

garminsdk/components/touchbutton/TouchButton.tsx:168


displayPaneSettingManager

displayPaneSettingManager: UserSettingManager<DisplayPaneSettings>

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:13


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

garminsdk/components/touchbutton/TouchButton.tsx:156


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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcTouchButton.tsx:16


getPaneViewKeyToDesignate

Optional getPaneViewKeyToDesignate: () => string

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.

Type declaration

▸ (): string

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:44


gtcOrientation

Optional gtcOrientation: GtcOrientation

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcTouchButton.tsx:34


imgSrc

Optional imgSrc: string

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.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

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

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

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

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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcTouchButton.tsx:22


isVisible

Optional isVisible: boolean | Subscribable<boolean>

Whether the button is visible. Defaults to true.

Inherited from

Omit.isVisible

Defined in

garminsdk/components/touchbutton/TouchButton.tsx:85


label

Optional label: string

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:22


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

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcTouchButton.tsx:28


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

garminsdk/components/touchbutton/TouchButton.tsx:165


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
NameType
Bextends TouchButton<TouchButtonProps> = TouchButton<TouchButtonProps>
Parameters
NameTypeDescription
buttonBThe button that was held.
totalHoldDurationnumberThe total amount of time, in milliseconds, that the button was held.
endReasonTouchButtonHoldEndReasonThe reason that the button exited the held state.
Returns

void

Inherited from

Omit.onHoldEnded

Defined in

garminsdk/components/touchbutton/TouchButton.tsx:137


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
NameType
Bextends TouchButton<TouchButtonProps> = TouchButton<TouchButtonProps>
Parameters
NameTypeDescription
buttonBThe 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

garminsdk/components/touchbutton/TouchButton.tsx:117


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
NameType
Bextends TouchButton<TouchButtonProps> = TouchButton<TouchButtonProps>
Parameters
NameTypeDescription
buttonBThe button that is held.
dtnumberThe elapsed time, in milliseconds, since the previous frame.
totalTimenumberThe total amount of time, in milliseconds, that the button has been held.
timeSinceLastPressnumberThe 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

garminsdk/components/touchbutton/TouchButton.tsx:129


onPressed

Optional onPressed: (isSelected: boolean, button: GtcDesignatedPaneButton) => void

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.

Type declaration

▸ (isSelected, button): void

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
NameType
isSelectedboolean
buttonGtcDesignatedPaneButton
Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:38


onPressedSelected

Optional onPressedSelected: (button: GtcDesignatedPaneButton) => void

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

Type declaration

▸ (button): void

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
NameType
buttonGtcDesignatedPaneButton
Returns

void

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:50


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

Type parameters
NameType
Bextends TouchButton<TouchButtonProps> = TouchButton<TouchButtonProps>
Parameters
NameTypeDescription
buttonBThe button that was touched.
Returns

TouchButtonOnTouchedAction

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

Inherited from

Omit.onTouched

Defined in

garminsdk/components/touchbutton/TouchButton.tsx:102


ref

Optional ref: NodeReference<any>

A reference to the display component.

Inherited from

Omit.ref

Defined in

sdk/components/FSComponent.ts:125


selectedImgSrc

Optional selectedImgSrc: string

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:31


selectedLabel

Optional selectedLabel: string

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

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:28


selectedPaneViewKeys

selectedPaneViewKeys: Iterable<string>

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.

Defined in

workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:19