graph

Documentation

Overview

Package graph implements different graph output formats.

Index

• Constants
• type Clustering
  • func (mode *Clustering) Set(value string) error
  • func (mode Clustering) String() string
• type Dot
  • func (ctx *Dot) WriteTo(w io.Writer) (n int64, err error)
• type DotBasic
  • func (ctx *DotBasic) WriteTo(w io.Writer) (n int64, err error)
• type ELK
  • func (ctx *ELK) WriteTo(w io.Writer) (n int64, err error)
• type GraphML
  • func (ctx *GraphML) WriteTo(w io.Writer) (n int64, err error)
• type Options

Constants

const (
	ClusterDisabled = Clustering("")
	ClusterByClass  = Clustering("class")
)

Clustering lists different ways of clustering.

Types

type Clustering

type Clustering string

Clustering is an enum for clustering modes.

func (*Clustering) Set

func (mode *Clustering) Set(value string) error

Set implements flag.Value such that Clustering can be used as a flag.

func (Clustering) String

func (mode Clustering) String() string

String returns the string representation of the clustering.

type Dot

type Dot struct {
	World *arch.World

	Options
}

Dot implements .dot encoding.

func (*Dot) WriteTo

func (ctx *Dot) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes dot output to w.

type DotBasic

type DotBasic struct {
	World *arch.World

	Options
}

DotBasic implements basic .dot encoding.

func (*DotBasic) WriteTo

func (ctx *DotBasic) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes dot output to w.

type ELK

type ELK struct {
	World *arch.World

	Options
}

ELK implements basic ELK compatible encoding.

func (*ELK) WriteTo

func (ctx *ELK) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes dot output to w.

type GraphML

type GraphML struct {
	World *arch.World

	Options
}

GraphML implements .graphml encoding.

func (*GraphML) WriteTo

func (ctx *GraphML) WriteTo(w io.Writer) (n int64, err error)

WriteTo writes .graphml encoding to w.

type Options

type Options struct {
	TrimPrefix string
	Clustering Clustering
	NoColor    bool
}

Options contains graph formatting and output configuration.