Class: PfdInsetRegistrar

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetRegistrar.ts:6

A record of registered PFD insets.

Constructors

Constructor

new PfdInsetRegistrar(): PfdInsetRegistrar

Returns

PfdInsetRegistrar

Methods

getRegisteredInsetsArray()

getRegisteredInsetsArray(): Readonly<PfdInsetDefinition>[]

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetRegistrar.ts:51

Gets an array of inset definitions registered with this registrar, in ascending order according to the values of their order properties.

Returns

Readonly<PfdInsetDefinition>[]

An array of inset definitions registered with this registrar, in ascending order according to the values of their order properties.

---

isInsetRegistered()

isInsetRegistered(key): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetRegistrar.ts:18

Checks if an inset is registered with a given key.

Parameters

Parameter	Type	Description
key	string	The key to check.

Returns

boolean

Whether an inset is registered with the specified key.

---

registerInset()

registerInset(insetDef): void

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetRegistrar.ts:28

Registers a PFD inset. Registering an inset with an existing key will replace the old inset registered under that key.

Parameters

Parameter	Type	Description
insetDef	Readonly<PfdInsetDefinition>	The definition of the inset to register.

Returns

void

Throws

Error if the inset key specified by the provided definition is the empty string.

---

unregisterInset()

unregisterInset(key): boolean

Defined in: src/workingtitle-instruments-g3x-touch/html_ui/GduDisplay/Gdu460/PfdInstruments/Inset/PfdInsetRegistrar.ts:41

Unregisters a PFD inset.

Parameters

Parameter	Type	Description
key	string	The key of the inset to unregister.

Returns

boolean

Whether the inset with the specified key was successfully unregistered.