HudOptions

Interface: HudOptions

Imported from @elite-dangerous-almanac/galaxy-map.

What the host asks the HUD for. Every field is optional.

Properties

datasetArrows?

readonly optional datasetArrows?: boolean

Draws a previous button and a next button around the dataset field, and an i / n counter after them. Each arrow loads the entry beside the loaded one in catalog order. It is false by default, and a value that is not a boolean reads as false.

---

host?

readonly optional host?: HTMLElement

Where the HUD is built. With none the library builds in the canvas's parent.

---

infoFields?

readonly optional infoFields?: HudInfoFields

Which worked-out fields the information panel shows. The setting covers every system, and a field the host turns off is not built.

---

lockedOptions?

readonly optional lockedOptions?: readonly HudMapOption[]

The map options the user may not change. A locked option draws no switch, and the handle's setters still move it. A name the list does not hold is ignored.

---

title?

readonly optional title?: string

The name in the top bar. The default is GALACTIC CARTOGRAPHICS.

Methods

details()?

optional details(system, signal): SystemDetails | Promise<SystemDetails | null> | null

Loads the description, the extra values and the footer buttons of one system. The panel calls it once for each system it opens on. The library aborts signal when the selection changes and on dispose, so a host that fetches can stop the work behind a dropped answer.

Parameters

system

RealSystem

signal

AbortSignal

Returns

SystemDetails | Promise<SystemDetails | null> | null