components/minimap-labels

Exports

Kind	Export	Description
Ttype alias	MinimapLabelSide	Where a mark’s name sits, or hidden.
Ttype alias	MinimapLabelInput	A caller-provided minimap label and its anchor.
Ttype alias	MinimapLabelMetrics	Measured label dimensions used to place minimap labels.
fnfunction	layoutMinimapLabels()	The side each mark’s label takes, index for index with marks.

MinimapLabelSideTtype alias

Signature

type MinimapLabelSide =
  | "below"
  | "above"
  | "right"
  | "left"
  | "below-right"
  | "below-left"
  | "above-right"
  | "above-left"
  | "hidden";

Where a mark’s name sits, or hidden.

---

MinimapLabelInputTtype alias

Signature

type MinimapLabelInput = Readonly<{
  x: number;
  y: number;
  named: boolean;
  solid: boolean;
  goal: boolean;
  label: string;
}>;

A caller-provided minimap label and its anchor.

---

MinimapLabelMetricsTtype alias

Signature

type MinimapLabelMetrics = Readonly<{
  width: number;
  height: number;
  charWidth: number;
  lineHeight: number;
  padding: number;
  dot: number;
  gap: number;
}>;

Measured label dimensions used to place minimap labels.

layoutMinimapLabels()fnfunction

Signature

function layoutMinimapLabels(marks, metrics): MinimapLabelSide[];

The side each mark’s label takes, index for index with marks.

Parameters

Parameter	Type
marks	readonly Readonly<{ x: number; y: number; named: boolean; solid: boolean; goal: boolean; label: string; }>[]
metrics	MinimapLabelMetrics

Returns

MinimapLabelSide[]