Interface: GtcMapRangeSettingSelectButtonProps
Component props for GtcMapRangeSelectButton.
Hierarchy
Omit<GtcListSelectTouchButtonProps<UserSetting<number>>,"state"|"listParams">↳
GtcMapRangeSettingSelectButtonProps
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
dialogCssClass
• Optional dialogCssClass: string
CSS class(es) to apply to the selection list dialog when opened.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:44
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
endIndex
• endIndex: number
The index of the largest selectable map range, inclusive.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:32
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/GtcValueTouchButton.tsx:16
gtcService
• gtcService: GtcService
The GTC service.
Overrides
Omit.gtcService
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:17
highlightButtonWhileListIsOpen
• Optional highlightButtonWhileListIsOpen: boolean
When true, the button will be highlighted while the list is open, and the isHighlighted prop will be ignored. Defaults to false.
Inherited from
Omit.highlightButtonWhileListIsOpen
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcListSelectTouchButton.tsx:32
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/GtcValueTouchButton.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 | VNode | Subscribable<string>
The label for the button. Can be defined as either a static string, a subscribable which provides the label
string, or a VNode. If not defined, the button will not have a label.
If the label is defined as a VNode, all first-level DisplayComponents in the VNode tree will be destroyed when the button is destroyed.
Inherited from
Omit.label
Defined in
garminsdk/components/touchbutton/TouchButton.tsx:94
listDialogKey
• listDialogKey: string
The key of the GTC list dialog the button will open as a selection list.
Inherited from
Omit.listDialogKey
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcListSelectTouchButton.tsx:20
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/GtcValueTouchButton.tsx:28
mapReadSettingManager
• mapReadSettingManager: UserSettingManager<G3000MapUserSettingTypes>
A manager for map user settings used to retrieve the displayed setting value.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:23
occlusionType
• Optional occlusionType: GtcViewOcclusionType
The occlusion type applied to views beneath the popup. Defaults to 'darken'.
Inherited from
Omit.occlusionType
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcListSelectTouchButton.tsx:23
onCancelled
• Optional onCancelled: <B>(state: UserSetting<number>, button: B) => void
A callback function which will be when the list was opened, and then cancelled.
Type declaration
▸ <B>(state, button): void
A callback function which will be when the list was opened, and then cancelled.
Type parameters
| Name | Type |
|---|---|
B | extends GtcListSelectTouchButton<UserSetting<number>> = GtcListSelectTouchButton<UserSetting<number>> |
Parameters
| Name | Type |
|---|---|
state | UserSetting<number> |
button | B |
Returns
void
Inherited from
Omit.onCancelled
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcListSelectTouchButton.tsx:49
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, state: UserSetting<number>, 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 state that is bound to the button.
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, state, totalHoldDuration, endReason): void
A function which is called when the button exits the held state.
Type parameters
| Name | Type |
|---|---|
B | extends ValueTouchButton<UserSetting<number>> = ValueTouchButton<UserSetting<number>> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was held. |
state | UserSetting<number> | The state that is bound to the button. |
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
garminsdk/components/touchbutton/ValueTouchButton.tsx:75
onHoldStarted
• Optional onHoldStarted: <B>(button: B, state: UserSetting<number>) => 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.
Param
The state that is bound to the button.
Type declaration
▸ <B>(button, state): 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 ValueTouchButton<UserSetting<number>> = ValueTouchButton<UserSetting<number>> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
state | UserSetting<number> | The state that is bound to the button. |
Returns
TouchButtonHoldAction
The action to take. Ignored if the value is equal to TouchButtonHoldAction.EndHold.
Inherited from
Omit.onHoldStarted
Defined in
garminsdk/components/touchbutton/ValueTouchButton.tsx:47
onHoldTick
• Optional onHoldTick: <B>(button: B, state: UserSetting<number>, 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 state that is bound to the button.
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, state, 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 ValueTouchButton<UserSetting<number>> = ValueTouchButton<UserSetting<number>> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that is held. |
state | UserSetting<number> | The state that is bound to the button. |
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
garminsdk/components/touchbutton/ValueTouchButton.tsx:60
onSelected
• Optional onSelected: <B>(value: number, state: UserSetting<number>, button: B) => void
A callback function which will be called every time a value is selected from the list. If not defined, selecting a value from the list will automatically set the button's bound state.
Type declaration
▸ <B>(value, state, button): void
A callback function which will be called every time a value is selected from the list. If not defined, selecting a value from the list will automatically set the button's bound state.
Type parameters
| Name | Type |
|---|---|
B | extends GtcListSelectTouchButton<UserSetting<number>> = GtcListSelectTouchButton<UserSetting<number>> |
Parameters
| Name | Type |
|---|---|
value | number |
state | UserSetting<number> |
button | B |
Returns
void
Inherited from
Omit.onSelected
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcListSelectTouchButton.tsx:44
onTouched
• Optional onTouched: <B>(button: B, state: UserSetting<number>) => 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.
Param
The state that is bound to the button.
Type declaration
▸ <B>(button, state): 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
| Name | Type |
|---|---|
B | extends ValueTouchButton<UserSetting<number>> = ValueTouchButton<UserSetting<number>> |
Parameters
| Name | Type | Description |
|---|---|---|
button | B | The button that was touched. |
state | UserSetting<number> | The state that is bound to the button. |
Returns
TouchButtonOnTouchedAction
The action to take as a result of the button being touched.
Inherited from
Omit.onTouched
Defined in
garminsdk/components/touchbutton/ValueTouchButton.tsx:30
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Omit.ref
Defined in
sdk/components/FSComponent.ts:125
renderValue
• Optional renderValue: VNode | (stateValue: number) => string | VNode
A function which renders the value of the button's bound state, or a VNode which renders the value. If not
defined, values are rendered into strings via default toString() behavior.
If the rendered value is a VNode, all first-level DisplayComponents in the VNode tree will be destroyed when a new value is rendered or when the button is destroyed.
Inherited from
Omit.renderValue
Defined in
garminsdk/components/touchbutton/ValueTouchButton.tsx:21
settingName
• settingName: "mapRangeIndex" | "mapAutoNorthUpRangeIndex" | "mapTerrainRangeIndex" | "mapAirportLargeRangeIndex" | "mapAirportMediumRangeIndex" | "mapAirportSmallRangeIndex" | "mapVorRangeIndex" | "mapNdbRangeIndex" | "mapIntersectionRangeIndex" | "mapUserWaypointRangeIndex" | "mapAirspaceClassBRangeIndex" | "mapAirspaceClassCRangeIndex" | "mapAirspaceClassDRangeIndex" | "mapAirspaceRestrictedRangeIndex" | "mapAirspaceMoaRangeIndex" | "mapAirspaceOtherRangeIndex" | "mapTrafficRangeIndex" | "mapTrafficLabelRangeIndex" | "mapNexradRangeIndex" | "mapTrackVectorLookahead"
The name of the bound setting.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:26
startIndex
• startIndex: number
The index of the smallest selectable map range, inclusive.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:29
title
• Optional title: string
The title of the selection list dialog.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:41
unitsSettingManager
• unitsSettingManager: UnitsUserSettingManager<UnitsUserSettingTypes>
A manager for display units user settings.
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:20
writeToSetting
• Optional writeToSetting: <K>(settingName: K, value: NonNullable<G3000MapUserSettingTypes[K]>) => void
A function which writes the selected value to the setting. If not defined, selected values will be written to
the setting retrieved from mapReadSettingManager.
Type declaration
▸ <K>(settingName, value): void
A function which writes the selected value to the setting. If not defined, selected values will be written to
the setting retrieved from mapReadSettingManager.
Type parameters
| Name | Type |
|---|---|
K | extends "mapRangeIndex" | "mapOrientation" | "mapAutoNorthUpActive" | "mapAutoNorthUpRangeIndex" | "mapGroundNorthUpActive" | "mapDeclutter" | "mapTerrainMode" | "mapTerrainRangeIndex" | "mapTerrainScaleShow" | "mapAirportLargeRangeIndex" | "mapAirportMediumRangeIndex" | "mapAirportSmallRangeIndex" | "mapVorShow" | "mapVorRangeIndex" | "mapNdbShow" | "mapNdbRangeIndex" | "mapIntersectionShow" | "mapIntersectionRangeIndex" | "mapUserWaypointShow" | "mapUserWaypointRangeIndex" | "mapAirspaceClassBRangeIndex" | "mapAirspaceClassCRangeIndex" | "mapAirspaceClassDRangeIndex" | "mapAirspaceRestrictedRangeIndex" | "mapAirspaceMoaRangeIndex" | "mapAirspaceOtherRangeIndex" | "mapTrafficShow" | "mapTrafficRangeIndex" | "mapTrafficLabelShow" | "mapTrafficLabelRangeIndex" | "mapTrafficAlertLevelMode" | "mapNexradShow" | "mapNexradRangeIndex" | "mapTrackVectorShow" | "mapTrackVectorLookahead" | "mapAltitudeArcShow" | "mapWindVectorShow" | "mapAirspaceShow" | "mapAirportShow" | "mapInsetMode" | "mapInsetTextCumulative" |
Parameters
| Name | Type |
|---|---|
settingName | K |
value | NonNullable<G3000MapUserSettingTypes[K]> |
Returns
void
Defined in
workingtitle-instruments-g3000/html_ui/Pages/VCockpit/Instruments/NavSystems/WTG3000/GTC/Components/TouchButton/GtcMapRangeSettingSelectButton.tsx:38