Skip to main content

Type Alias: GtcDialogChainStep<Dialog>

GtcDialogChainStep<Dialog> = object

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:15

A definition for a single step in a dialog chain.

Type Parameters

Type Parameter
Dialog extends GtcDialogView<any, any>

Properties

delay?

optional delay: number

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:42

The delay, in milliseconds, after the step has finished before the next step can begin.


input()

input: (chainOutput) => GtcDialogInputType<Dialog>

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:30

A function which generates the request input to pass to the opened dialog.

Parameters

ParameterTypeDescription
chainOutputreadonly GtcDialogResult<any>[]The outputs of each prior step in the dialog chain, in order.

Returns

GtcDialogInputType<Dialog>

The request input to pass to the opened dialog.


key

key: string

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:17

The key of the dialog to open.


onResult()?

optional onResult: (result) => boolean

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:39

A callback function which is invoked when the opened dialog returns a result and returns whether the chain should continue. If not defined, no action will be taken when the dialog returns a result and the chain will continue if and only if the dialog request was not cancelled.

Parameters

ParameterTypeDescription
resultGtcDialogResult<GtcDialogOutputType<Dialog>>The result returned by the opened dialog.

Returns

boolean

Whether the chain should continue.


popupOcclusionType?

optional popupOcclusionType: GtcViewOcclusionType

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:23

The occlusion type to apply to views beneath the opened dialog. Defaults to 'darken'.


popupType?

optional popupType: GtcPopupType

Defined in: workingtitle-instruments-g3000/html_ui/GTC/Dialog/GtcDialogs.tsx:20

The popup type to apply to the opened dialog. Defaults to 'normal'.