package core

Import Path
	github.com/d2lang/elk-go/internal/core (on go.dev)

Dependency Relation
	imports 9 packages, and imported by 18 packages

Involved Source Files

	    codec.go
	    engine.go
	    options.go
	  d registry.go
		Package core implements ELK metadata, JSON conversion, and recursive layout.

	    topdown.go
Package-Level Type Names (total 12)

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

		Fields (total 4)
			Create func() LayoutProvider
			Features GraphFeature
			ID string
			KnownOptions []string
		As Outputs Of (at least 3)
			func (*AlgorithmRegistry).Algorithms() []*AlgorithmData
			func (*AlgorithmRegistry).ByID(id string) *AlgorithmData
			func (*AlgorithmRegistry).BySuffix(suffix string) *AlgorithmData
		As Inputs Of (at least one exported)
			func (*AlgorithmRegistry).Register(algorithm AlgorithmData) error

	 type AlgorithmRegistry (struct)

		Methods (total 4)
			(*AlgorithmRegistry) Algorithms() []*AlgorithmData
			(*AlgorithmRegistry) ByID(id string) *AlgorithmData
			(*AlgorithmRegistry) BySuffix(suffix string) *AlgorithmData
			(*AlgorithmRegistry) Register(algorithm AlgorithmData) error
		As Outputs Of (at least one exported)
			func NewAlgorithmRegistry() *AlgorithmRegistry
		As Inputs Of (at least 13)
			func NewEngine(options *OptionRegistry, algorithms *AlgorithmRegistry) *Engine
			func github.com/d2lang/elk-go/internal/basic.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/box.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/builtins.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/fixed.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/force.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/layeredlayout.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/mrtree.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/radial.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/random.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/rectpacking.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/spore.Register(registry *AlgorithmRegistry) error
			func github.com/d2lang/elk-go/internal/stress.Register(registry *AlgorithmRegistry) error

	 type Codec (struct)
		Codec imports ELK JSON into the algorithm graph and transfers computed
		layout back into the same public graph objects.

		Fields (only one)
			Options *OptionRegistry
		Methods (total 2)
			(*Codec) Import(input *graphjson.Graph) (*graph.Model, error)
				Import validates graph references and constructs the native arena.

			(*Codec) TransferLayout(model *graph.Model) error
				TransferLayout copies all layout output into the public objects imported by
				the most recent Import call.

		As Outputs Of (at least one exported)
			func NewCodec(options *OptionRegistry) *Codec

	 type Engine (struct)
		Engine applies registered providers recursively across graph hierarchy.

		Fields (total 3)
			Algorithms *AlgorithmRegistry
			Monitor ProgressMonitor
			Options *OptionRegistry
		Methods (only one)
			(*Engine) Layout(model *graph.Model) error
		As Outputs Of (at least one exported)
			func NewEngine(options *OptionRegistry, algorithms *AlgorithmRegistry) *Engine

	 type GraphFeature uint32 (basic type)

		Methods (only one)
			( GraphFeature) Has(feature GraphFeature) bool
		As Inputs Of (at least one exported)
			func GraphFeature.Has(feature GraphFeature) bool
		As Types Of (total 9)
			const FeatureClusters
			const FeatureCompound
			const FeatureDisconnected
			const FeatureEdgeLabels
			const FeatureHyperedges
			const FeatureInsideSelfLoops
			const FeatureMultiEdges
			const FeaturePorts
			const FeatureSelfLoops

	 type IndividualSpacings (struct)

		Fields (only one)
			Properties graph.PropertyMap

	 type LayoutProvider (interface)
		LayoutProvider lays out one parent node and its children.

		Methods (only one)
			( LayoutProvider) Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
		Implemented By (at least 9)
			*github.com/d2lang/elk-go/internal/box.Provider
			*github.com/d2lang/elk-go/internal/fixed.Provider
			*github.com/d2lang/elk-go/internal/force.Provider
			*github.com/d2lang/elk-go/internal/layeredlayout.Provider
			*github.com/d2lang/elk-go/internal/mrtree.Provider
			*github.com/d2lang/elk-go/internal/radial.Provider
			*github.com/d2lang/elk-go/internal/random.Provider
			*github.com/d2lang/elk-go/internal/rectpacking.Provider
			*github.com/d2lang/elk-go/internal/stress.Provider

	 type OptionData (struct)
		OptionData describes one layout option and how its JSON spelling is parsed.

		Fields (total 9)
			EnumValues []string
			Format func(any) string
			Group string
			ID string
			Kind OptionKind
			LegacyIDs []string
			MetadataOnly bool
				MetadataOnly marks UI or programmatic metadata that the headless JSON
				layout engine preserves but does not interpret during layout.

			Parse func(string) (any, error)
			Targets Targets
		Methods (total 2)
			(*OptionData) FormatValue(value any) string
			(*OptionData) ParseValue(value string) (any, bool)
		As Outputs Of (at least 3)
			func (*OptionRegistry).ByID(id string) *OptionData
			func (*OptionRegistry).BySuffix(suffix string) *OptionData
			func (*OptionRegistry).Options() []*OptionData
		As Inputs Of (at least one exported)
			func (*OptionRegistry).Register(option OptionData) error

	 type OptionKind uint8 (basic type)

		As Types Of (total 8)
			const BooleanOption
			const DoubleOption
			const EnumOption
			const EnumSetOption
			const IntegerOption
			const ObjectOption
			const StringOption
			const UndefinedOption

	 type OptionRegistry (struct)
		OptionRegistry is insertion ordered and performs ELK's unique dot-boundary
		suffix lookup.

		Methods (total 4)
			(*OptionRegistry) ByID(id string) *OptionData
			(*OptionRegistry) BySuffix(suffix string) *OptionData
			(*OptionRegistry) Options() []*OptionData
			(*OptionRegistry) Register(option OptionData) error
		As Outputs Of (at least one exported)
			func NewOptionRegistry() *OptionRegistry
		As Inputs Of (at least 13)
			func NewCodec(options *OptionRegistry) *Codec
			func NewEngine(options *OptionRegistry, algorithms *AlgorithmRegistry) *Engine
			func RegisterCoreOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/basic.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/basicoptions.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/builtins.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/force.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/layered.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/mrtree.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/radial.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/rectpacking.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/spore.RegisterOptions(registry *OptionRegistry)
			func github.com/d2lang/elk-go/internal/stress.RegisterOptions(registry *OptionRegistry)

	 type ProgressMonitor (interface)
		ProgressMonitor is deliberately small; providers can report work while
		callers that do not need progress use NullProgressMonitor.

		Methods (total 5)
			( ProgressMonitor) Begin(task string, totalWork float64)
			( ProgressMonitor) Canceled() bool
			( ProgressMonitor) Done()
			( ProgressMonitor) Subtask(work float64) ProgressMonitor
			( ProgressMonitor) Worked(work float64)
		As Outputs Of (at least one exported)
			func ProgressMonitor.Subtask(work float64) ProgressMonitor
		As Inputs Of (at least 11)
			func LayoutProvider.Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/box.(*Provider).Layout(model *graph.Model, parent graph.NodeID, _ ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/fixed.(*Provider).Layout(model *graph.Model, parent graph.NodeID, _ ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/force.InitialLayout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/force.(*Provider).Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/layeredlayout.(*Provider).Layout(model *basegraph.Model, parent basegraph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/mrtree.(*Provider).Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/radial.(*Provider).Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/random.(*Provider).Layout(model *graph.Model, parent graph.NodeID, _ ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/rectpacking.(*Provider).Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
			func github.com/d2lang/elk-go/internal/stress.(*Provider).Layout(model *graph.Model, parent graph.NodeID, monitor ProgressMonitor) error
		As Types Of (only one)
			  var NullProgressMonitor

	 type Targets uint8 (basic type)

		As Types Of (total 5)
			const Edges
			const Labels
			const Nodes
			const Parents
			const Ports


Package-Level Functions (total 7)

	 func IsSelfLoop(model *graph.Model, edgeID graph.EdgeID) bool
	 func NewAlgorithmRegistry() *AlgorithmRegistry
	 func NewCodec(options *OptionRegistry) *Codec
	 func NewEngine(options *OptionRegistry, algorithms *AlgorithmRegistry) *Engine
	 func NewOptionRegistry() *OptionRegistry
	 func RegisterCoreOptions(registry *OptionRegistry)
	 func TranslateSection(model *graph.Model, sectionID graph.SectionID, offset geometry.Point)
		TranslateSection moves every point in a section by offset.


Package-Level Variables (total 60)

	  var Algorithm graph.Property[...]
	  var Animate graph.Property[...]
		Headless elkjs exposes these UI and programmatic options through
		knownLayoutOptions, but they do not affect native layout execution.

	  var AnimationFactor graph.Property[...]
	  var AspectRatio graph.Property[...]
	  var ChildAreaHeight graph.Property[...]
	  var ChildAreaWidth graph.Property[...]
	  var CommentBox graph.Property[...]
		Core graph semantics consumed by ELK Layered and node micro-layout.

	  var ContentAlignment graph.Property[...]
	  var Direction graph.Property[...]
	  var EdgeType graph.Property[...]
	  var FontName graph.Property[...]
	  var FontSize graph.Property[...]
	  var HierarchyHandling graph.Property[...]
	  var Hypernode graph.Property[...]
	  var InsideSelfLoopsActivate graph.Property[...]
	  var InsideSelfLoopsEdge graph.Property[...]
	  var InteractiveLayout graph.Property[...]
	  var JSONEdgeCoords graph.Property[...]
	  var JSONShapeCoords graph.Property[...]
	  var JunctionPoints graph.Property[...]
	  var LabelManager graph.Property[...]
	  var LayoutAncestors graph.Property[...]
	  var MaxAnimationTime graph.Property[...]
	  var MinAnimationTime graph.Property[...]
	  var NodeSizeConstraints graph.Property[...]
	  var NodeSizeMinimum graph.Property[...]
	  var NoLayout graph.Property[...]
	  var NullProgressMonitor ProgressMonitor
	  var Padding graph.Property[...]
	  var PartitioningActivate graph.Property[...]
	  var PartitioningPartition graph.Property[...]
	  var PortAlignmentEast graph.Property[...]
	  var PortAlignmentNorth graph.Property[...]
	  var PortAlignmentSouth graph.Property[...]
	  var PortAlignmentWest graph.Property[...]
	  var PortAnchor graph.Property[...]
	  var PortConstraints graph.Property[...]
	  var PortLabelsNextToPortIfPossible graph.Property[...]
	  var PortLabelsTreatAsGroup graph.Property[...]
	  var PortSide graph.Property[...]
	  var ProgressBar graph.Property[...]
	  var ResolvedAlgorithm graph.Property[...]
	  var ScaleFactor graph.Property[...]
	  var SoftwrappingFuzziness graph.Property[...]
	  var SpacingCommentComment graph.Property[...]
	  var SpacingCommentNode graph.Property[...]
	  var SpacingIndividual graph.Property[...]
	  var SpacingNodeNode graph.Property[...]
	  var TopdownHierarchicalNodeAspectRatio graph.Property[...]
	  var TopdownHierarchicalNodeWidth graph.Property[...]
	  var TopdownLayout graph.Property[...]
	  var TopdownNodeType graph.Property[...]
	  var TopdownScaleCap graph.Property[...]
	  var TopdownScaleFactor graph.Property[...]
	  var TopdownSizeApproximator graph.Property[...]
	  var TopdownSizeCategories graph.Property[...]
	  var TopdownSizeCategoriesHierarchicalNodeWeight graph.Property[...]
	  var ValidateGraph graph.Property[...]
	  var ValidateOptions graph.Property[...]
	  var ZoomToFit graph.Property[...]
Package-Level Constants (total 23)

	const BooleanOption OptionKind = 1
	const DefaultAlgorithmID = "org.eclipse.elk.layered"
	const DoubleOption OptionKind = 3
	const Edges Targets = 4
	const EnumOption OptionKind = 4
	const EnumSetOption OptionKind = 5
	const FeatureClusters GraphFeature = 64
	const FeatureCompound GraphFeature = 32
	const FeatureDisconnected GraphFeature = 128
	const FeatureEdgeLabels GraphFeature = 8
	const FeatureHyperedges GraphFeature = 256
	const FeatureInsideSelfLoops GraphFeature = 2
	const FeatureMultiEdges GraphFeature = 4
	const FeaturePorts GraphFeature = 16
	const FeatureSelfLoops GraphFeature = 1
	const IntegerOption OptionKind = 2
	const Labels Targets = 16
	const Nodes Targets = 2
	const ObjectOption OptionKind = 6
	const Parents Targets = 1
	const Ports Targets = 8
	const StringOption OptionKind = 0
	const UndefinedOption OptionKind = 7

The pages are generated with Golds v0.8.7. (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.