Interface: GtcGenericViewProps

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:10

Component props for GtcGenericView.

Extends

• GtcViewProps

Properties

children?

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from

GtcViewProps.children

---

controlMode

controlMode: GtcControlMode

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:17

The GTC control mode to which the view belongs.

Inherited from

GtcViewProps.controlMode

---

displayPaneIndex?

optional displayPaneIndex: ControllableDisplayPaneIndex

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:26

The index of the display pane associated with the view, or undefined if the view is not associated with any display pane.

Inherited from

GtcViewProps.displayPaneIndex

---

gtcService

gtcService: GtcService

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:14

The GtcService instance.

Inherited from

GtcViewProps.gtcService

---

isInOverlayStack?

optional isInOverlayStack: boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcView.ts:20

Whether the view belongs to its GTC control mode's overlay view stack.

Inherited from

GtcViewProps.isInOverlayStack

---

onClose()?

optional onClose: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:39

A callback function to execute when the view is closed.

Parameters

Parameter	Type	Description
view	GtcGenericView	The closed view.

Returns

void

---

onDestroy()?

optional onDestroy: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:65

A callback function to execute when the view is destroyed.

Parameters

Parameter	Type	Description
view	GtcGenericView	The destroyed view.

Returns

void

---

onInteractionEvent()?

optional onInteractionEvent: (view, event) => boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:59

A callback function which handles interaction events.

Parameters

Parameter	Type	Description
view	GtcGenericView	The view to which the event was sent.
event	GtcInteractionEvent	An interaction event.

Returns

boolean

Whether the event was handled.

---

onInUse()?

optional onInUse: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:21

A callback function to execute when the view comes in use.

Parameters

Parameter	Type	Description
view	GtcGenericView	The in-use view.

Returns

void

---

onOpen()?

optional onOpen: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:33

A callback function to execute when the view is opened.

Parameters

Parameter	Type	Description
view	GtcGenericView	The opened view.

Returns

void

---

onOutOfUse()?

optional onOutOfUse: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:27

A callback function to execute when the view goes out of use.

Parameters

Parameter	Type	Description
view	GtcGenericView	The out-of-use view.

Returns

void

---

onPause()?

optional onPause: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:45

A callback function to execute when the view is paused.

Parameters

Parameter	Type	Description
view	GtcGenericView	The paused view.

Returns

void

---

onResume()?

optional onResume: (view) => void

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:51

A callback function to execute when the view is resumed.

Parameters

Parameter	Type	Description
view	GtcGenericView	The resumed view.

Returns

void

---

ref?

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from

GtcViewProps.ref

---

sidebarState?

optional sidebarState: GtcSidebarState

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:15

The sidebar state (labels and buttons) requested by the view.

---

title

title: string | Subscribable<string>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/GtcService/GtcGenericView.tsx:12

The title of the view.