Behaviour for specialized diagram renderers.
Each renderer implements render/2 which takes a diagram-specific
struct and render options, returning a string.
Built-in renderers
Boxart.Render.Sequence— sequence diagramsBoxart.Render.Mindmap— mind mapsBoxart.Render.PieChart— horizontal bar chartsBoxart.Render.StateDiagram— state machine diagramsBoxart.Render.GitGraph— git branch/commit graphsBoxart.Render.Gantt— Gantt charts
Implementing a custom renderer
defmodule MyDiagram do
@behaviour Boxart.Diagram
defmodule Model do
defstruct [:data]
end
@impl true
def render(%Model{} = diagram, opts) do
# return a string
end
end
Summary
Callbacks
Renders the diagram as a string.
Types
@type opts() :: keyword()