GalaxyMapOptions

Interface: GalaxyMapOptions

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

Options for createGalaxyMap.

Properties

bounds?

readonly optional bounds?: BrowseBounds

How much of the space the user may browse. It clamps the cursor and the far zoom limit, and it changes nothing the map draws. The default is unrestricted, which is the model bounds and a 120,000 light year far limit. A setting the map cannot read takes the default.

---

cursorMarker?

readonly optional cursorMarker?: boolean

False takes the cursor marker off. The marker is on unless the options turn it off, because nothing else on the screen says where the cursor is. A host that draws its own cursor turns this one off here or with setCursorMarkerVisible.

---

dataset?

readonly optional dataset?: string

The id of the entry the map loads at start. With no id, and with an id the catalog does not hold, the map loads the first entry.

---

datasets?

readonly optional datasets?: readonly DatasetEntry[]

The data sets the user can switch between. Each entry carries an id, a label and a load() the host wrote. The library calls load() and reads what comes back; it fetches nothing itself. With no catalog the map loads nothing and the HUD shows no dataset field.

---

grid?

readonly optional grid?: boolean

True draws the coordinate grid. The grid is off unless the options ask for it.

---

hud?

readonly optional hud?: boolean | HudOptions

Builds the heads-up display. true builds it with its defaults, and an object names the title, the host and the footer actions. The HUD is off when the options do not ask for it, and the map then adds no element to the page.

---

interaction?

readonly optional interaction?: Partial<InteractionSwitches>

Which of the user's inputs the map acts on. A field the host leaves out is on. A setting the map cannot read leaves every switch on.

---

labelHost?

readonly optional labelHost?: HTMLElement

The element the region labels go in. With no element the library makes one in the canvas's parent, so a host that gives a canvas alone gets a working map.

---

loadingImage?

readonly optional loadingImage?: string

The URL of a picture the map shows in the middle of the canvas while it starts. The library removes it when ready settles, whether it settles or fails. A URL whose scheme is neither http nor https, and which is not relative, adds no element. With no URL the map adds no element.

---

nebulae?

readonly optional nebulae?: NebulaSource<unknown, unknown>

The nebula source, which is the single export of the package's ./nebulae subpath. With it the map fetches the records and the art and draws the nebulae. With no value the map fetches no nebula file, compiles no nebula program and draws no nebula, and reports no error: asking for no nebulae is not a fault.

A value the map cannot read turns the nebulae off, as every other option of this library does. A host passes the value it imported and writes no source of its own.

---

regions?

readonly optional regions?: boolean

False takes the region overlay off. The overlay is on unless the options turn it off. A value that is not a boolean takes the default.

---

shapes?

readonly optional shapes?: boolean

False takes the spheres and the lines off. The shapes are on unless the options turn them off. A value that is not a boolean takes the default.

---

startView?

readonly optional startView?: StartView

The camera the map opens at. The map takes it in the frame it draws first and does not fly to it. A field the host leaves out takes the value of the default view. A setting the map cannot read is ignored in whole.

---

systemIcons?

readonly optional systemIcons?: boolean

False takes the system icon stacks off. The stacks are on unless the options turn them off, because an icon draws only where a record names one, so a set that names none opens on nothing new. A value that is not a boolean takes the default.

---

systemNames?

readonly optional systemNames?: boolean

True starts the map with the marker name labels on. The labels are off unless the options ask for them, because a set of 50,000 systems opens on a screen of labels otherwise. A value that is not a boolean takes the default.