Diagram

The central type for producing diagrams

A Diagram can be either a Diagram.Single (a diagram of a single RefTree), or Diagram.Multiple — a diagram containing several trees.

Diagrams can be combined using the + operator.

Each diagram is associated with a hierarchical namespace. This namespace scopes the ids of the trees in the diagram. Put simply, two List diagrams will share the same Nil tree node if they are in the same namespace, and will each have its own Nil node otherwise.

Diagrams can have “anchors” which prevent their root nodes from moving between adjacent animation frames. For more details see Animation.

Usage examples:

// no caption
Diagram(Queue(1))

// automatically set caption to "Queue(1) :+ 2"
Diagram.sourceCodeCaption(Queue(1) :+ 2)

// use toString to get the caption, i.e. "Queue(1, 2)"
Diagram.toStringCaption(Queue(1) :+ 2)

// merge two diagrams, set captions manually
Diagram(Queue(1)).withCaption("one") + Diagram(Queue(2)).withCaption("two")

// isolate each diagram in its own namespace
Diagram(Queue(1)).toNamespace("one") + Diagram(Queue(2)).toNamespace("two")

Linear Supertypes

AnyRef, Any

Known Subclasses

Multiple, Single

Abstract Value Members

abstract def fragments: Seq[Single]

The fragments of this diagram

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
def +(that: Diagram): Diagram

Combine with another diagram
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toNamespace(name: String): Diagram

Put this diagram into a namespace with the given name (add one more hierarchy level)
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withoutAnchors: Diagram

Remove anchors from all fragments
def withoutCaptions: Diagram

Remove captions from all fragments

Related Docs: object Diagram | package diagram

sealed trait Diagram extends AnyRef

Abstract Value Members

abstract def fragments: Seq[Single]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

def +(that: Diagram): Diagram

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toNamespace(name: String): Diagram

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withoutAnchors: Diagram

def withoutCaptions: Diagram

Inherited from AnyRef

Inherited from Any

Ungrouped