Class

reftree.render

Renderer

Related Doc: package render

Permalink

case class Renderer(renderingOptions: RenderingOptions = RenderingOptions(), animationOptions: AnimationOptions = AnimationOptions()) extends Product with Serializable

This class provides functionality for rendering diagrams and animations

It can be used in two ways:

Usage examples:

import reftree.diagram.Diagram
import org.scalajs.dom

val renderer = Renderer(
  renderingOptions = RenderingOptions(density = 75)
)

// Conventional usage
renderer
  .tweakRendering(_.withVerticalSpacing(2))
  .render(dom.document.body, Diagram(List(1)))

// Sweet sugar, recommended
import renderer._
Diagram(List(1))
  .render(dom.document.body, _.withVerticalSpacing(2))
Self Type
Renderer
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Renderer
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Renderer(renderingOptions: RenderingOptions = RenderingOptions(), animationOptions: AnimationOptions = AnimationOptions())

    Permalink

Type Members

  1. implicit class AnimationRenderSyntax extends AnyRef

    Permalink

    Syntactic sugar for animations

  2. implicit class DiagramRenderSyntax extends AnyRef

    Permalink

    Syntactic sugar for diagrams

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. val animationOptions: AnimationOptions

    Permalink

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. def render(target: Node, animation: Animation): Unit

    Permalink

    Render an animation to a given DOM node

  15. def render(target: Node, diagram: Diagram): Unit

    Permalink

    Render a diagram to a given DOM node

  16. val renderingOptions: RenderingOptions

    Permalink

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  18. def tweakAnimation(tweak: (AnimationOptions) ⇒ AnimationOptions): Renderer

    Permalink

    Tweak the animation options with the provided funciton

  19. def tweakRendering(tweak: (RenderingOptions) ⇒ RenderingOptions): Renderer

    Permalink

    Tweak the rendering options with the provided funciton

  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped