DatasetEntry

Interface: DatasetEntry

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

One entry of the catalog, as the host writes it.

Properties

bounds?

readonly optional bounds?: BrowseBounds

Where the set lives. An entry that names none restores the map's own option.

---

collection?

readonly optional collection?: string

The group the dialog lists the entry under.

---

description?

readonly optional description?: string

What the set holds, as a paragraph.

---

id

readonly id: string

The identity of the entry. loadDataset takes it.

---

label

readonly label: string

The name the HUD shows.

---

region?

readonly optional region?: string

Where in the galaxy the set holds records.

---

systemCount?

readonly optional systemCount?: number

How many systems the set holds.

---

view?

readonly optional view?: ViewInput

Where the camera opens on a load of this entry. An entry that names bounds and a view of fit: 'systems' alone holds the camera where the user put it, whenever the camera is inside the new bounds. DatasetView states the four conditions and the two ways to keep the frame on every load.

Methods

load()

load(signal): DatasetContent | Promise<DatasetContent>

Reads the set. The library calls it and adds what comes back.

The map aborts signal when a later load starts and when the map is disposed while this load is in flight. A load that fetches passes the signal to fetch, so a download that nobody reads stops. A load that declares no parameter still fits.

Parameters

signal

AbortSignal

Returns

DatasetContent | Promise<DatasetContent>