Type Alias: LabelRule

type LabelRule =
  | {
      kind: 'tree';
      leaf: Uint8Array;
      orientation: 'TB' | 'BT' | 'LR' | 'RL';
    }
  | {
      angle: Float64Array;
      kind: 'radial';
      leaf: Uint8Array;
      radius: Float64Array;
    }
  | {
      arcs: 'above' | 'below';
      kind: 'arc';
      vertical: boolean;
    }
  | {
      axis: Int32Array;
      axisAngle: Float64Array;
      kind: 'hive';
    };

What an arrangement says about where its labels have room (node.textposition: 'auto'). Angles are degrees counter-clockwise from the x axis in layout coordinates (y up), as the layouts return them.

Union Members

Type Literal

{
  kind: 'tree';
  leaf: Uint8Array;
  orientation: 'TB' | 'BT' | 'LR' | 'RL';
}

A tidy tree or a dendrogram: beyond a leaf, and beside a node whose children show. leaf: 1 for the nodes without children showing (leaves, and collapsed nodes).

---

Type Literal

{
  angle: Float64Array;
  kind: 'radial';
  leaf: Uint8Array;
  radius: Float64Array;
}

A radial tree: along the radius, outwards from a leaf and inwards from the others.

---

Type Literal

{
  arcs: 'above' | 'below';
  kind: 'arc';
  vertical: boolean;
}

An arc diagram: on the side of the line the arcs are not on (arcs: the side they are on).

---

Type Literal

{
  axis: Int32Array;
  axisAngle: Float64Array;
  kind: 'hive';
}

A hive plot: beside the node's axis.