LineInput

Interface: LineInput

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

What a host passes to addLines.

Indexable

[field: string]: unknown

A field the reader drops.

Properties

categories?

readonly optional categories?: readonly string[]

The names of categories the table holds, in the order the line reads them. The first one that is on for shapes gives the colour, where the line carries none.

---

closed?

readonly optional closed?: boolean

True joins the last point to the first. The default is false.

---

color?

readonly optional color?: readonly [number, number, number]

Red, green and blue, each from 0 to 255. A line that names a category may leave it out and take the colour of the first category it names that is on.

---

name?

readonly optional name?: string

What the shape stands for. The map draws no label for it.

---

points

readonly points: readonly LinePoint[]

At least two points, each a coordinate or a system reference.

---

primaryCategory?

readonly optional primaryCategory?: undefined

The two names categories replaces. Each one is never, so a shape that carries it fails the compile. The index signature below turns off TypeScript's excess-property check, so without the pair the old name would compile and the reader would drop it.

---

secondaryCategories?

readonly optional secondaryCategories?: undefined

---

width?

readonly optional width?: number

How wide the ribbon draws, in CSS pixels. The default is 2.