d2layouts

Documentation

Index

• func DefaultRouter(ctx context.Context, graph *d2graph.Graph, edges []*d2graph.Edge) error
• func ExtractSubgraph(container *d2graph.Object, includeSelf bool) (nestedGraph *d2graph.Graph, externalEdges []*d2graph.Edge, ...)
• func FitToGraph(container *d2graph.Object, nestedGraph *d2graph.Graph, padding geo.Spacing)
• func InjectNested(container *d2graph.Object, nestedGraph *d2graph.Graph, isRoot bool)
• func LayoutNested(ctx context.Context, g *d2graph.Graph, graphInfo GraphInfo, ...) error
• func PositionNested(container *d2graph.Object, nestedGraph *d2graph.Graph)
• func SaveChildrenOrder(container *d2graph.Object) (restoreOrder func())
• func SaveOrder(g *d2graph.Graph) (restoreOrder func())
• type DiagramType
• type GraphInfo
  • func NestedGraphInfo(obj *d2graph.Object) (gi GraphInfo)

Functions

func DefaultRouter

func DefaultRouter(ctx context.Context, graph *d2graph.Graph, edges []*d2graph.Edge) error

func ExtractSubgraph

func ExtractSubgraph(container *d2graph.Object, includeSelf bool) (nestedGraph *d2graph.Graph, externalEdges []*d2graph.Edge, externalEdgeIDs []edgeIDs)

func FitToGraph

func FitToGraph(container *d2graph.Object, nestedGraph *d2graph.Graph, padding geo.Spacing)

func InjectNested

func InjectNested(container *d2graph.Object, nestedGraph *d2graph.Graph, isRoot bool)

func LayoutNested

func LayoutNested(ctx context.Context, g *d2graph.Graph, graphInfo GraphInfo, coreLayout d2graph.LayoutGraph, edgeRouter d2graph.RouteEdges) error

func PositionNested

func PositionNested(container *d2graph.Object, nestedGraph *d2graph.Graph)

func SaveChildrenOrder

func SaveChildrenOrder(container *d2graph.Object) (restoreOrder func())

func SaveOrder

func SaveOrder(g *d2graph.Graph) (restoreOrder func())

Types

type DiagramType

type DiagramType string

const (
	DefaultGraphType  DiagramType = ""
	ConstantNearGraph DiagramType = "constant-near"
	GridDiagram       DiagramType = "grid-diagram"
	SequenceDiagram   DiagramType = "sequence-diagram"
)

a grid diagram at a constant near is

type GraphInfo

type GraphInfo struct {
	IsConstantNear bool
	DiagramType    DiagramType
}

func NestedGraphInfo

func NestedGraphInfo(obj *d2graph.Object) (gi GraphInfo)