sequence

Documentation

Index

• type Diagram
  • func NewDiagram(filename string) *Diagram
  • func (d *Diagram) AddDirectionalEdge(from, to string, label string) error
  • func (d *Diagram) AddParticipants(name ...string)
  • func (d *Diagram) AddUndirectionalEdge(from, to string, label string) error
  • func (d *Diagram) Render()
  • func (d *Diagram) SetTitle(s string)

Types

type Diagram

type Diagram struct {
	// contains filtered or unexported fields
}

Diagram represents a diagram

func NewDiagram

func NewDiagram(filename string) *Diagram

NewDiagram init function

func (*Diagram) AddDirectionalEdge

func (d *Diagram) AddDirectionalEdge(from, to string, label string) error

AddDirectionalEdge adds a connection (renders as an arrowed line) between two participants

func (*Diagram) AddParticipants

func (d *Diagram) AddParticipants(name ...string)

AddParticipants sets the `participant` array on the Diagram object

func (*Diagram) AddUndirectionalEdge

func (d *Diagram) AddUndirectionalEdge(from, to string, label string) error

AddUndirectionalEdge adds a connection (renders as a line) between two participants

func (*Diagram) Render

func (d *Diagram) Render()

Render generates an image from a `Diagram` object

func (*Diagram) SetTitle

func (d *Diagram) SetTitle(s string)

SetTitle sets the diagram's title