Skip to main content

Class: GtcMinimumsControl

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:43

A GTC minimums control component. Provides a number pad and cursor input allowing the user to select a minimums value, and a button which opens a dialog to allow the user to select a minimums mode.

Extends

Implements

Constructors

Constructor

new GtcMinimumsControl(props): GtcMinimumsControl

Defined in: sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsGtcMinimumsControlPropsThe propertis of the component.

Returns

GtcMinimumsControl

Inherited from

DisplayComponent<GtcMinimumsControlProps>.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: GtcMinimumsControlProps & 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/Minimums/GtcMinimumsControl.tsx:707

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

ParameterTypeDescription
contextneverThe 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/Minimums/GtcMinimumsControl.tsx:87

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


onClose()

onClose(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:243

A callback which is called when this control's parent view is closed.

Returns

void


onGtcInteractionEvent()

onGtcInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:248

Handles a GtcInteractionEvent.

Parameters

ParameterTypeDescription
eventGtcInteractionEventThe event to handle.

Returns

boolean

Whether the event was handled.

Implementation of

GtcInteractionHandler.onGtcInteractionEvent


onOpen()

onOpen(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:230

A callback which is called when this control's parent view is opened.

Returns

void


onResume()

onResume(): void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:223

A callback which is called when this control's parent view is resumed.

Returns

void


render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Components/Minimums/GtcMinimumsControl.tsx:369

Returns

VNode

Inherit Doc

Overrides

DisplayComponent.render