Class MachineUiElements`Beta`

Represents the UI elements of a machine.

Implements

Iterable<[string, UiElementDefinition]>

Index

Constructors

Methods

[iterator] definitions get has ids

Constructors

constructor

new MachineUiElements(
elements: Record<string, UiElementDefinition>,
): MachineUiElements
Beta
Parameters
- elements: Record<string, UiElementDefinition>
Returns MachineUiElements
- Defined in public_api/src/machine_ui_elements.ts:13

Methods

[iterator]

"[iterator]"(): Iterator<[string, UiElementDefinition]>
Beta
Enables iteration over the UI elements.

Returns Iterator<[string, UiElementDefinition]>
Implementation of Iterable.[iterator]
- Defined in public_api/src/machine_ui_elements.ts:74

definitions

definitions(): Iterable<UiElementDefinition>
Beta
Creates an iterable of the definitions of all the UI elements.

Returns Iterable<UiElementDefinition>
An iterable of the definitions of all the UI elements.
- Defined in public_api/src/machine_ui_elements.ts:51

get

get(id: string): UiElementDefinition | undefined
Beta
Gets a UI element by its ID.
Parameters
- id: string
  The ID of the UI element to get.
Returns UiElementDefinition | undefined
The UI element with the specified ID, or undefined if it doesn't exist. The returned object is frozen; copy it if you need to modify it.
- Defined in public_api/src/machine_ui_elements.ts:32

has

has(id: string): boolean
Beta
Test if a UI element with the given ID exists.
Parameters
- id: string
Returns boolean
A boolean indicating whether the UI element with the specified ID exists.
- Defined in public_api/src/machine_ui_elements.ts:22

ids

ids(): string[]
Beta
Gets the IDs of all the UI elements.

Returns string[]
An array containing the IDs of all the UI elements.
- Defined in public_api/src/machine_ui_elements.ts:42