package d2elklayout

Import Path
	oss.terrastruct.com/d2/d2layouts/d2elklayout (on go.dev)

Dependency Relation
	imports 16 packages, and imported by one package

Involved Source Files

	    elk.go
	  d layout.go
		d2elklayout is a wrapper around the Javascript port of ELK.
		
		Coordinates are relative to parents.
		See https://www.eclipse.org/elk/documentation/tooldevelopers/graphdatastructure/coordinatesystem.html
Package-Level Type Names (total 10)

	/* sort by: alphabet | popularity */
	 type ConfigurableOpts (struct)

		Fields (total 5)
			Algorithm string
			EdgeNodeSpacing int
			NodeSpacing int
			Padding string
			SelfLoopSpacing int
		As Inputs Of (at least one exported)
			func Layout(ctx context.Context, g *d2graph.Graph, opts *ConfigurableOpts) (err error)
		As Types Of (only one)
			  var DefaultOpts

	 type Direction string (basic type)

		As Types Of (total 4)
			const Down
			const Left
			const Right
			const Up

	 type ELKEdge (struct)

		Fields (total 6)
			Container string
			ID string
			Labels []*ELKLabel
			Sections []ELKEdgeSection
			Sources []string
			Targets []string

	 type ELKEdgeSection (struct)

		Fields (total 3)
			BendPoints []ELKPoint
			End ELKPoint
			Start ELKPoint

	 type ELKGraph (struct)

		Fields (total 4)
			Children []*ELKNode
			Edges []*ELKEdge
			ID string
			LayoutOptions *elkOpts

	 type ELKLabel (struct)

		Fields (total 6)
			Height float64
			LayoutOptions *elkOpts
			Text string
			Width float64
			X float64
			Y float64

	 type ELKNode (struct)

		Fields (total 9)
			Children []*ELKNode
			Height float64
			ID string
			Labels []*ELKLabel
			LayoutOptions *elkOpts
			Ports []*ELKPort
			Width float64
			X float64
			Y float64

	 type ELKPoint (struct)

		Fields (total 2)
			X float64
			Y float64

	 type ELKPort (struct)

		Fields (total 6)
			Height float64
			ID string
			LayoutOptions *elkOpts
			Width float64
			X float64
			Y float64

	 type PortSide string (basic type)

		As Types Of (total 4)
			const East
			const North
			const South
			const West


Package-Level Functions (total 2)

	 func DefaultLayout(ctx context.Context, g *d2graph.Graph) (err error)
	 func Layout(ctx context.Context, g *d2graph.Graph, opts *ConfigurableOpts) (err error)
Package-Level Variables (only one)

	  var DefaultOpts ConfigurableOpts
Package-Level Constants (total 8)

	const Down Direction = "DOWN"
	const East PortSide = "EAST"
	const Left Direction = "LEFT"
	const North PortSide = "NORTH"
	const Right Direction = "RIGHT"
	const South PortSide = "SOUTH"
	const Up Direction = "UP"
	const West PortSide = "WEST"

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.