Skip to main content

Interface: FmcScreenOptions

Defined in: src/sdk/fmc/FmcScreen.ts:14

Options for an FMC screen

Properties​

enableScratchpad?​

optional enableScratchpad: boolean

Defined in: src/sdk/fmc/FmcScreen.ts:48

Whether to enable the scratchpad. Defaults to true.

eventPrefix?​

optional eventPrefix: string

Defined in: src/sdk/fmc/FmcScreen.ts:54

A prefix for fmc events. Currently used for multiple FMCs on one instrument scenarios.

lskNotHandledThrowValue?​

optional lskNotHandledThrowValue: any

Defined in: src/sdk/fmc/FmcScreen.ts:29

The value that is thrown when an LSK event is not handled by anything.

Default: the string 'KEY NOT ACTIVE'.

screenDimensions​

screenDimensions: object

Defined in: src/sdk/fmc/FmcScreen.ts:16

Screen dimensions

cellHeight​

cellHeight: number

Screen character row height

cellWidth​

cellWidth: number

Screen character cell width

textInputFieldDisallowedDeleteThrowValue?​

optional textInputFieldDisallowedDeleteThrowValue: any

Defined in: src/sdk/fmc/FmcScreen.ts:36

The value that is thrown when a text input fields receives a DELETE when deleteAllowed is false.

Default: the string 'INVALID DELETE'.

textInputFieldParseFailThrowValue?​

optional textInputFieldParseFailThrowValue: any

Defined in: src/sdk/fmc/FmcScreen.ts:43

The value that is thrown when a text input fields fails to parse a scratchpad entry.

Default: the string 'INVALID ENTRY'.