Skip to content

The standalone page ​

umlimator.py render writes one self-contained HTML file: the module inlined, the model in the page, and nothing fetched. It opens from disk in any browser, works offline, and can be attached to an issue or hosted as it is.

bash
python3 umlimator.py render examples/umlimator-atlas.json --out page.html   # the interactive page, then its layout check

The same viewer is mountPage(container, model) in the module, built on render() through the public API.

What the page has ​

FeatureHow to reach it
Breadcrumbs and a views listthe path above the map; ☰ or O for the list
A details panel per cardselect a card; [ and ] move between its tabs
Search⌘K (Ctrl + K)
Paths and reach→ and ← in the details panel (or the > and < keys) light what a card leads to and what leads to it; with two cards selected, ⇄ (or P) lights every path between them
Budgets and what-if⏱ and ¤ light the slowest or costliest path from a card; ⊘ lights what loses its way if the card goes down
Stories and lensesthe Stories and Lenses menus, when the model has any (Stories, lenses and live data)
Light and darkthe ◐ toggle
ExportSVG · this view, PNG · this view (2×), Copy link to view, Map model (JSON), and Record a story…

A view, a selected card, a story step or a lens can be linked to. A selected line or box is not kept in the link:

LinkOpens
#view=<id>&node=<id>a view, with a card selected
#story=<id>&step=<n>a story at a step (1-based), shown but not playing on
#lens=<id>the page with a lens on

Keyboard and screen readers ​

Cards, then lines, are in the Tab order (a card's tabs and chips too, for a host that listens for click). Arrow keys move between cards. Enter selects the focused card, and Enter on the selected card opens its view. Esc or Backspace clears the selection, and with nothing selected goes back up. Selections are announced in the map's live region, and describe(model, viewId) gives a view in plain sentences for a text alternative.

Exports ​

  • SVG and PNG: any view as a stand-alone file, from the page's Export menu, from map.toSVG() and map.toPNG() in a host, or from umlimator.py stills.
  • Map model (JSON): the whole model as its file has it, named after the model's title in its own letters, any script, with each run of other characters one - (the Umlimator Atlas, titled "Umlimator Atlas", gives umlimator-atlas.json; a title with no letters or digits gives map.json). SVG and PNG add the view's id the same way (umlimator-atlas-overview.svg). What render added to the page is taken off again (its icons table, the avatars it inlined, the layouts its search baked), and what it replaced is put back (an intake logo's path, the model's own meta.generated). What render leaves out of the page for privacy, such as an avatar or example image that names an address, is not in the export either.
  • Copy link to view: the page's address with the view, card, story step or lens it shows (see Links above).
  • PDF: the whole map as one document to hand in for a review: a cover with the contents, each view with its legend and tables of its cards, lines and boxes, then the rules (umlimator.py pdf; see Command line).
  • Animated PNG: a story, frame by frame (umlimator.py record).

For scripts and tests ​

The page keeps its map's handle on window.umlimatorMap: the Handle that render() returns (setView(), highlight(), tour(), play() ...).