Boxart.Render.Sequence (Boxart v0.3.1)

Renderer for sequence diagrams.

Draws participants as boxes at the top, vertical lifelines, horizontal message arrows between them, activation boxes, interaction blocks (loop/alt/opt/par), and notes.

Uses Boxart.Canvas for all drawing operations.

Summary

Types

arrow_type()

event()

line_type()

participant_type()

Functions

render(diagram, opts \\ [])

Renders a SequenceDiagram to a string.

render_canvas(diagram, opts \\ [])

Renders a SequenceDiagram to a Boxart.Canvas.

Types

arrow_type()

@type arrow_type() :: :arrow | :open | :cross | :async

event()

@type event() ::
  Boxart.Render.Sequence.Message.t()
  | Boxart.Render.Sequence.Note.t()
  | Boxart.Render.Sequence.Block.t()
  | Boxart.Render.Sequence.Activate.t()
  | Boxart.Render.Sequence.Destroy.t()

line_type()

@type line_type() :: :solid | :dotted

participant_type()

@type participant_type() :: :participant | :actor

Functions

render(diagram, opts \\ [])

@spec render(
  Boxart.Render.Sequence.SequenceDiagram.t(),
  keyword()
) :: String.t()

Renders a SequenceDiagram to a string.

Options

:charset — :unicode (default) or :ascii
:padding_x — horizontal padding inside participant boxes (default: 4)
:gap — minimum gap between participant centers (default: 16)

render_canvas(diagram, opts \\ [])

@spec render_canvas(
  Boxart.Render.Sequence.SequenceDiagram.t(),
  keyword()
) :: Boxart.Canvas.t()

Renders a SequenceDiagram to a Boxart.Canvas.