Packages

•  package root

  Definition Classes

  root

•  package reftree

  Definition Classes

  root

•  package render

  Definition Classes

  reftree

•  case class Renderer(renderingOptions: RenderingOptions = RenderingOptions(), animationOptions: AnimationOptions = AnimationOptions(), directory: Path = Paths.get("."), format: String = "png") extends Product with Serializable

  This class provides functionality for rendering diagrams and animations

  This class provides functionality for rendering diagrams and animations

  It can be used in two ways:

  • conventionally, via the render methods;
  • with special syntax sugar, allowing render calls on the diagrams/animations themselves.

  Usage examples:

  import reftree.diagram.Diagram
  import java.nio.file.Paths
  
  val renderer = Renderer(
    renderingOptions = RenderingOptions(density = 75),
    directory = Paths.get("images", "usage")
  )
  
  // With custom output format
  val renderer = Renderer(
    renderingOptions = RenderingOptions(density = 75),
    directory = Paths.get("images", "usage"),
    format = "ps" // Or any other format that compatible with dot -T
  )
  
  // Conventional usage
  renderer
    .tweakRendering(_.withVerticalSpacing(2))
    .render("list", Diagram(List(1)))
  
  // Sweet sugar, recommended
  import renderer._
  Diagram(List(1))
    .render("list", _.withVerticalSpacing(2))

  Definition Classes

  render

• AnimationRenderSyntax
• DiagramRenderSyntax

reftree.render.Renderer

AnimationRenderSyntax