Interface TileTextStep

One rung of the ladder: a complete description of what a tile shows.

interface TileTextStep {
    label: TileTextVariant;
    sublabel: "none" | TileTextVariant;
    sublabelLines: number | null;
    index: boolean;
    labelScale: number;
    labelWrap: "words" | "anywhere";
}

Properties

The label's version. short falls back to full where none was authored.

sublabel: "none" | TileTextVariant

The sublabel's version, or none to drop it.

sublabelLines: number | null

Most lines a sublabel may take, ellipsised past that; null = unlimited.

index: boolean

Whether the tour-position numeral is shown.

labelScale: number

Multiplier on the label's fitted font size.

labelWrap: "words" | "anywhere"

anywhere lets a label break inside a word; the very last resort.