Class: MapRangeSettingSelectButton
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:42
A touchscreen button which displays the value of a map range setting and when pressed, opens a selection list dialog to set the value of the setting.
Extends
DisplayComponent
<MapRangeSettingSelectButtonProps
>
Constructors
Constructor
new MapRangeSettingSelectButton(
props
):MapRangeSettingSelectButton
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | MapRangeSettingSelectButtonProps | The propertis of the component. |
Returns
MapRangeSettingSelectButton
Inherited from
DisplayComponent<MapRangeSettingSelectButtonProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
focusableComponentRef
readonly
focusableComponentRef:NodeReference
<UiFocusableComponent
&DisplayComponent
<any
, []>>
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:46
A reference to this button's focusable component.
props
props:
MapRangeSettingSelectButtonProps
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:146
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: src/sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | Type | Description |
---|---|---|
context | never | The context to get the subscription for. |
Returns
never
The requested context.
Throws
An error if no data for the specified context type could be found.
Inherited from
DisplayComponent.getContext
getRootElement()
getRootElement():
HTMLElement
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:60
Gets this button's root HTML element.
Returns
HTMLElement
This button's root HTML element.
Throws
Error if this button has not yet been rendered.
onAfterRender()
onAfterRender():
void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:51
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
Inherited from
DisplayComponent.onBeforeRender
render()
render():
VNode
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:74
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
simulatePressed()
simulatePressed(
ignoreDisabled
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/MFD/Components/TouchButton/MapRangeSettingSelectButton.tsx:69
Simulates this button being pressed. This will execute the onPressed()
callback if one is defined.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
ignoreDisabled | boolean | false | Whether to simulate the button being pressed regardless of whether the button is disabled. Defaults to false . |
Returns
void