Interface: MapRangeSettingSelectButtonProps
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:19
Component props for MapRangeSettingSelectButton.
Extends
Omit
<UiListSelectTouchButtonProps
<MutableSubscribable
<number
>>,"listParams"
>
Properties
canBeFocused?
optional
canBeFocused:boolean
|Subscribable
<boolean
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:123
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/UiValueTouchButton.tsx:129
CSS class(es) to apply to the button's root element.
Inherited from
Omit.class
containerRef?
optional
containerRef:NodeReference
<HTMLElement
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:41
A reference to the UI view container that contains the button. Required in order to open the button's UI list dialog as a positioned popup.
Inherited from
Omit.containerRef
dialogBackgroundOcclusion?
optional
dialogBackgroundOcclusion:UiViewOcclusionType
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:68
The occlusion type to apply to views beneath the UI list dialog popup. Defaults to 'darken'
.
Inherited from
Omit.dialogBackgroundOcclusion
dialogPositionAlign?
optional
dialogPositionAlign:"top-right"
|"bottom-left"
|"bottom-right"
|"top-left"
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:53
The edges of the button to which to align the reference corner of the button's UI list dialog. Ignored if
openDialogAsPositioned
is false
. Defaults to top-left
.
Inherited from
Omit.dialogPositionAlign
dialogPositionReference?
optional
dialogPositionReference:"top-right"
|"bottom-left"
|"bottom-right"
|"top-left"
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:47
The reference corner of the button's UI list dialog, which will be aligned to the button if
openDialogAsPositioned
is true
. Defaults to top-left
.
Inherited from
Omit.dialogPositionReference
dialogPositionXOffset?
optional
dialogPositionXOffset:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:59
The horizontal offset to apply to the button's UI list dialog positioning after alignment with the button, in
pixels. Ignored if openDialogAsPositioned
is false
. Defaults to 0
.
Inherited from
Omit.dialogPositionXOffset
dialogPositionYOffset?
optional
dialogPositionYOffset:number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:65
The vertical offset to apply to the button's UI list dialog positioning after alignment with the button, in
pixels. Ignored if openDialogAsPositioned
is false
. Defaults to 0
.
Inherited from
Omit.dialogPositionYOffset
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
endIndex
endIndex:
number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:29
The index of the largest selectable map range, inclusive.
focusController?
optional
focusController:UiFocusController
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:117
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/UiValueTouchButton.tsx:93
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/UiValueTouchButton.tsx:126
Options to configure the button's behavior related to UI focus.
Inherited from
Omit.focusOptions
hideDropdownArrow?
optional
hideDropdownArrow:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:71
Whether to hide the button's dropdown arrow. Defaults to false
.
Inherited from
Omit.hideDropdownArrow
highlightButtonWhileListIsOpen?
optional
highlightButtonWhileListIsOpen:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:80
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
includeOff?
optional
includeOff:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:32
Whether to include the 'Off' (-1
) setting in the selection list.
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/UiValueTouchButton.tsx:99
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
label?
optional
label:string
|VNode
|Subscribable
<string
>
Defined in: src/garminsdk/components/touchbutton/TouchButton.tsx:94
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
listDialogKey
listDialogKey:
string
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:29
The key of the UI list dialog the button will open as a selection list.
Inherited from
Omit.listDialogKey
listDialogLayer
listDialogLayer:
UiViewStackLayer
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:26
The view stack layer in which to open the button's UI list dialog.
Inherited from
Omit.listDialogLayer
listParams
listParams:
Readonly
<MapRangeSettingSelectButtonListParams
>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:35
Parameters to pass to the selection list dialog.
listScrollAxis?
optional
listScrollAxis:"x"
|"y"
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:105
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
onCancelled()?
optional
onCancelled: <B
>(state
,button
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:98
A callback function which will be called each time a list dialog opened by the button is closed before a value is selected.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiListSelectTouchButton <MutableSubscribable <number , number >> | UiListSelectTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type |
---|---|
state | MutableSubscribable |
button | B |
Returns
void
Inherited from
Omit.onCancelled
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/UiValueTouchButton.tsx:81
A function which is called when the button gains UI focus.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
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/UiValueTouchButton.tsx:87
A function which is called when the button loses UI focus.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type | Description |
---|---|---|
button | B | The button that lost UI focus. |
Returns
void
Inherited from
Omit.onFocusLost
onHoldEnded()?
optional
onHoldEnded: <B
>(button
,state
,totalHoldDuration
,endReason
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:70
A function which is called when the button exits the held state.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type | Description |
---|---|---|
button | B | The button that was held. |
state | MutableSubscribable | 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
onHoldStarted()?
optional
onHoldStarted: <B
>(button
,state
) =>TouchButtonHoldAction
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:42
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 UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type | Description |
---|---|---|
button | B | The button that is held. |
state | MutableSubscribable | 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
onHoldTick()?
optional
onHoldTick: <B
>(button
,state
,dt
,totalTime
,timeSinceLastPress
) =>TouchButtonHoldAction
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.tsx:55
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 UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type | Description |
---|---|---|
button | B | The button that is held. |
state | MutableSubscribable | 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
onSelected()?
optional
onSelected: <B
>(value
,state
,button
) =>void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:92
A callback function which will be called each time a value is selected from a list dialog opened by the button. If not defined, then selecting a value from the list will automatically set the button's bound state.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiListSelectTouchButton <MutableSubscribable <number , number >> | UiListSelectTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type |
---|---|
value | number |
state | MutableSubscribable |
button | B |
Returns
void
Inherited from
Omit.onSelected
onTouched()?
optional
onTouched: <B
>(button
,state
) =>TouchButtonOnTouchedAction
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/Shared/Components/TouchButton/UiValueTouchButton.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 entering the primed state when touched.
Type Parameters
Type Parameter | Default type |
---|---|
B extends UiValueTouchButton <MutableSubscribable <number , number >> | UiValueTouchButton <MutableSubscribable <number , number >> |
Parameters
Parameter | Type | Description |
---|---|---|
button | B | The button that was touched. |
state | MutableSubscribable | 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
openDialogAsPositioned?
optional
openDialogAsPositioned:boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:35
Whether to open the button's UI list dialog as a positioned popup. If false
, then the dialog will be opened as a
normal popup. Defaults to false
.
Inherited from
Omit.openDialogAsPositioned
ref?
optional
ref:NodeReference
<any
>
Defined in: src/sdk/components/FSComponent.ts:125
A reference to the display component.
Inherited from
Omit.ref
renderValue?
optional
renderValue:VNode
| (stateValue
) =>string
|VNode
Defined in: src/garminsdk/components/touchbutton/ValueTouchButton.tsx:21
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
startIndex
startIndex:
number
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:26
The index of the smallest selectable map range, inclusive.
state
state:
MutableSubscribable
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:74
A mutable subscribable whose state will be bound to the button.
Inherited from
Omit.state
uiService
uiService:
UiService
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/UiListSelectTouchButton.tsx:23
The UI service.
Inherited from
Omit.uiService
unitsSettingManager
unitsSettingManager:
UnitsUserSettingManager
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:23
A manager for display units user settings.