Systems on the map

Systems on the map

Add the categories first, then the records. The reader rejects a record whose category is missing.

import { createGalaxyMap } from '@elite-dangerous-almanac/galaxy-map';

const canvas = document.querySelector('canvas') as HTMLCanvasElement;
const map = createGalaxyMap(canvas);

map.addCategories([
  { name: 'Empire', color: [153, 230, 255], description: 'Imperial space' },
  { name: 'Federation', color: [255, 140, 60], markerStyle: 'disc' },
  { name: 'Landmark', color: [255, 255, 255], maxDrawRange: 5000 },
]);

const report = map.addSystems([
  { name: 'Sol', coords: { x: 0, y: 0, z: 0 }, categories: ['Federation'] },
  {
    name: 'Achenar',
    coords: { x: 67.5, y: -119.46, z: 24.84 },
    categories: ['Empire'],
  },
]);
console.log(report.added, report.replaced, report.rejected.length);

await map.ready;

Run this example

addSystems reads the record shape an EDSM or a Spansh dump gives. It keeps the fields the map needs, drops the rest, and reports each record it rejects with the reason. A record whose id64, or whose name, the set already holds replaces the earlier one.

The set holds MAX_SYSTEMS records, which is 50,000. A record over that bound is rejected with the reason over-capacity, so read the number and cut a larger source before you call addSystems. The map allocates no buffer for the bound: it grows the buffers with the records, so a map of ten records costs ten records.

A category carries a name, an RGB colour and the optional description, markerStyle and maxDrawRange. The name is the identity: a category added again replaces the first. markerStyle is glow, a soft halo, or disc, a filled circle with a dark ring. maxDrawRange is how far the cursor may be from a system and still draw its marker, in light years.

The reference

SystemRecordInput is the record, CategoryInput is the category, and AddReport and CategoryReport are what the two calls give back. Reject and CategoryReject carry the reason for each record the reader turned down.