Class: GtcDesignatedPaneButton
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:60
A touchscreen button displaying a label and image whose state is dependent on the designated pane view of a display pane. The button is considered selected when the designated pane view is one of a set of specified views. When selected, the button is marked with a cyan border and optionally displays a different label and image. The button can be configured to execute certain actions based on whether it is selected, including setting the designated and displayed pane views to a specific view.
Extends
DisplayComponent
<GtcDesignatedPaneButtonProps
>
Constructors
Constructor
new GtcDesignatedPaneButton(
props
):GtcDesignatedPaneButton
Defined in: sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | GtcDesignatedPaneButtonProps | The propertis of the component. |
Returns
GtcDesignatedPaneButton
Inherited from
DisplayComponent<GtcDesignatedPaneButtonProps>.constructor
Properties
context?
optional
context: [] =undefined
Defined in: sdk/components/FSComponent.ts:64
The context on this component, if any.
Inherited from
DisplayComponent.context
contextType?
readonly
optional
contextType: readonly [] =undefined
Defined in: sdk/components/FSComponent.ts:67
The type of context for this component, if any.
Inherited from
DisplayComponent.contextType
props
props:
GtcDesignatedPaneButtonProps
&ComponentProps
Defined in: sdk/components/FSComponent.ts:61
The properties of the component.
Inherited from
DisplayComponent.props
Methods
destroy()
destroy():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:157
Returns
void
Inherit Doc
Overrides
DisplayComponent.destroy
getContext()
protected
getContext(context
):never
Defined in: 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
onAfterRender()
onAfterRender():
void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:85
Returns
void
Inherit Doc
Overrides
DisplayComponent.onAfterRender
onBeforeRender()
onBeforeRender():
void
Defined in: 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: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:106
Returns
VNode
Inherit Doc
Overrides
DisplayComponent.render
simulatePressed()
simulatePressed(
ignoreDisabled
):void
Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/TouchButton/GtcDesignatedPaneButton.tsx:101
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