Package: github.com/d2lang/dagro

package dagro Import Path github.com/d2lang/dagro (on go.dev) Dependency Relation imports 12 packages, and imported by one package

Involved Source Files acyclic.go add_border_segments.go attrs.go callback.go coordinate_system.go debug.go feasible_tree.go graph.go greedy_fas.go layout.go list.go nesting_graph.go network_simplex.go normalize.go numeric_semantics.go order.go order_add_subgraph_constraints.go order_barycenter.go order_build_layer_graph.go order_cross_count.go order_init.go order_resolve_conflicts.go order_sort.go order_sort_subgraph.go parent_dummy_chains.go position.go position_bk.go rank.go rank_util.go util.go version.go

Package-Level Type Names (total 6)

/* sort by: alphabet | popularity */

type Attrs (map) Attrs is Dagro's equivalent of a JavaScript object used as a graph, node, or edge label by the verified Dagre profile.

type Edge (struct) Edge uniquely identifies an edge. HasName distinguishes an unnamed edge from a named edge whose name happens to be empty. Fields (total 4) HasName bool Name string V string W string As Outputs Of (at least 4) func (*Graph).Edges() []Edge func (*Graph).InEdges(v string, u ...string) []Edge func (*Graph).NodeEdges(v string, w ...string) []Edge func (*Graph).OutEdges(v string, w ...string) []Edge As Inputs Of (at least 4) func (*Graph).Edge(e Edge) any func (*Graph).HasEdgeObject(e Edge) bool func (*Graph).RemoveEdge(e Edge) *Graph func (*Graph).SetEdgeObject(e Edge, value ...any) *Graph

type Graph (struct) Graph implements the D2-used Graphlib 4.0.5 operations plus the operations required by Dagre's verified default layout path. Methods (total 38) (*Graph) Children(v ...string) []string (*Graph) Edge(e Edge) any (*Graph) EdgeByArgs(v, w string, name ...string) any (*Graph) EdgeCount() int (*Graph) Edges() []Edge (*Graph) FilterNodes(filter func(string) bool) *Graph FilterNodes returns a graph containing the nodes accepted by filter and the edges between them. A retained compound node is attached to its nearest retained ancestor when its immediate parent is filtered out. (*Graph) Graph() any (*Graph) HasEdge(v, w string, name ...string) bool (*Graph) HasEdgeObject(e Edge) bool (*Graph) HasNode(v string) bool (*Graph) InEdges(v string, u ...string) []Edge (*Graph) IsCompound() bool (*Graph) IsDirected() bool (*Graph) IsLeaf(v string) bool (*Graph) IsMultigraph() bool (*Graph) Neighbors(v string) []string (*Graph) Node(v string) any (*Graph) NodeCount() int (*Graph) NodeEdges(v string, w ...string) []Edge (*Graph) Nodes() []string (*Graph) OutEdges(v string, w ...string) []Edge (*Graph) Parent(v string) (string, bool) (*Graph) Predecessors(v string) []string (*Graph) RemoveEdge(e Edge) *Graph (*Graph) RemoveEdgeByArgs(v, w string, name ...string) *Graph (*Graph) RemoveNode(v string) *Graph (*Graph) SetDefaultEdgeLabel(value any) *Graph (*Graph) SetDefaultNodeLabel(value any) *Graph (*Graph) SetEdge(v, w string, args ...any) *Graph (*Graph) SetEdgeObject(e Edge, value ...any) *Graph SetEdgeObject is the edge-object form of graphlib's setEdge. (*Graph) SetGraph(label any) *Graph (*Graph) SetNode(v string, value ...any) *Graph (*Graph) SetNodes(vs []string, value ...any) *Graph (*Graph) SetParent(v string, parent ...string) error (*Graph) SetPath(vs []string, value ...any) *Graph (*Graph) Sinks() []string (*Graph) Sources() []string (*Graph) Successors(v string) []string As Outputs Of (at least 14) func DebugOrdering(g *Graph) *Graph func NewGraph(opts ...GraphOptions) *Graph func (*Graph).FilterNodes(filter func(string) bool) *Graph func (*Graph).RemoveEdge(e Edge) *Graph func (*Graph).RemoveEdgeByArgs(v, w string, name ...string) *Graph func (*Graph).RemoveNode(v string) *Graph func (*Graph).SetDefaultEdgeLabel(value any) *Graph func (*Graph).SetDefaultNodeLabel(value any) *Graph func (*Graph).SetEdge(v, w string, args ...any) *Graph func (*Graph).SetEdgeObject(e Edge, value ...any) *Graph func (*Graph).SetGraph(label any) *Graph func (*Graph).SetNode(v string, value ...any) *Graph func (*Graph).SetNodes(vs []string, value ...any) *Graph func (*Graph).SetPath(vs []string, value ...any) *Graph As Inputs Of (at least 2) func DebugOrdering(g *Graph) *Graph func Layout(g *Graph, options ...LayoutOptions) error

type GraphOptions (struct) GraphOptions is the D2-used subset of Graphlib 4.0.5's Graph options. Fields (total 4) Compound bool Directed bool Multigraph bool Undirected bool As Inputs Of (at least one exported) func NewGraph(opts ...GraphOptions) *Graph

type LayoutOptions (struct) LayoutOptions controls optional diagnostic behavior. Fields (only one) DebugTiming bool As Inputs Of (at least one exported) func Layout(g *Graph, options ...LayoutOptions) error

type Point (struct) Point is a point in the coordinate system produced by Layout. Fields (total 2) X float64 Y float64

Package-Level Functions (total 5)

func DebugOrdering(g *Graph) *Graph DebugOrdering returns the ordering graph produced by Dagre's debug helper.

func Layout(g *Graph, options ...LayoutOptions) error Layout runs the verified Dagre 3.1.1 default-path profile and writes coordinates and routes back to g. The input graph's topology is not modified.

func NewGraph(opts ...GraphOptions) *Graph NewGraph constructs a graph. Graphs are directed by default, matching graphlib; set Undirected for an undirected graph.

func NoTime(_ string, fn any) any NoTime evaluates fn without timing or logging, matching Dagre's util.notime.

func Time(name string, fn any) (result any) Time evaluates fn and logs its elapsed wall time, matching Dagre's public util.time helper. The deferred log preserves the upstream finally behavior.

Package-Level Constants (total 2)

const GraphlibVersion = "4.0.5" GraphlibVersion identifies the Graphlib behavioral source used by the port.

const Version = "3.1.1" Version identifies the Dagre behavioral source targeted by the D2 profile.