Class: PfdPageRegistrar
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdPage/PfdPageRegistrar.ts:6
A record of registered PFD pane pages.
Constructors
Constructor
new PfdPageRegistrar():
PfdPageRegistrar
Returns
PfdPageRegistrar
Methods
getRegisteredPagesArray()
getRegisteredPagesArray():
Readonly
<PfdPageDefinition
>[]
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdPage/PfdPageRegistrar.ts:46
Gets an array of page definitions registered with this registrar, in ascending order according to the values of
their order
properties.
Returns
Readonly
<PfdPageDefinition
>[]
An array of page definitions registered with this registrar, in ascending order according to the values
of their order
properties.
isPageRegistered()
isPageRegistered(
key
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdPage/PfdPageRegistrar.ts:18
Checks if a page is registered with a given key.
Parameters
Parameter | Type | Description |
---|---|---|
key | string | The key to check. |
Returns
boolean
Whether a page is registered with the specified key.
registerPage()
registerPage(
pageDef
):void
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdPage/PfdPageRegistrar.ts:27
Registers a PFD page. Registering a page with an existing key will replace the old page registered under that key.
Parameters
Parameter | Type | Description |
---|---|---|
pageDef | Readonly <PfdPageDefinition > | The definition of the page to register. |
Returns
void
unregisterPage()
unregisterPage(
key
):boolean
Defined in: src/workingtitle-instruments-g3x-touch/html_ui/PFD/PfdPage/PfdPageRegistrar.ts:36
Unregisters a PFD page.
Parameters
Parameter | Type | Description |
---|---|---|
key | string | The key of the page to unregister. |
Returns
boolean
Whether the page with the specified key was successfully unregistered.