Expand description
Headless automatic layout integration.
This module is a thin runtime facade over jellyflow-layout: it turns a layout request into a
normal graph transaction, then lets the store’s dispatch/profile pipeline apply it.
Structs§
- Dugong
Layout Apply Outcome - Result of applying a dugong layout through the store.
- Dugong
Layout Engine - Built-in Dagre-compatible layout engine powered by
dugong. - Layout
Apply Outcome - Result of applying a layout engine through the store.
- Layout
Context - Runtime or host-owned context available to layout engines.
- Layout
Edge Route - A layout-produced edge route.
- Layout
Engine Id - Stable identifier for a layout engine.
- Layout
Engine Metadata - Discovery metadata for one layout engine.
- Layout
Engine Registry - Caller-owned registry of layout engines.
- Layout
Engine Request - Request for one selected layout engine.
- Layout
Family Id - Stable identifier for a layout engine family.
- Layout
Family Metadata - Metadata for a group of layout engines with related behavior.
- Layout
Node Position - A node position produced by a layout run.
- Layout
Options - Options shared by Jellyflow layout adapters.
- Layout
Preset Builder - Builder for common layout presets.
- Layout
Request - A headless layout request.
- Layout
Result - Result of a headless layout run.
- Layout
Spacing - Spacing knobs passed through to layout engines that support layered spacing.
- Mind
MapFreeform Layout Engine - Built-in freeform mind-map engine that only resolves overlaps.
- Mind
MapRadial Layout Engine - Built-in radial mind-map engine.
- Tidy
Tree Layout Engine - Built-in tidy tree layout engine.
Enums§
- Dugong
Layout Apply Error - Errors from planning or dispatching a dugong layout.
- Layout
Apply Error - Errors from planning or dispatching a layout engine.
- Layout
Direction - Direction for a layered graph layout.
- Layout
Engine Capability - Public capabilities hosts can use when choosing a layout engine.
- Layout
Error - Errors reported by layout projection, registry lookup, or layout output conversion.
- Layout
Scope - Which nodes a layout request should include.
Constants§
- DUGONG_
LAYOUT_ ENGINE_ ID - Stable engine id for the built-in Dagre-compatible
dugongengine. - LAYERED_
DAG_ LAYOUT_ FAMILY_ ID - Stable family id for DAG/layered graph layout engines.
- MIND_
MAP_ FREEFORM_ LAYOUT_ ENGINE_ ID - Stable engine id for the built-in freeform mind-map engine.
- MIND_
MAP_ LAYOUT_ FAMILY_ ID - Stable family id for mind-map layout engines.
- MIND_
MAP_ RADIAL_ LAYOUT_ ENGINE_ ID - Stable engine id for the built-in radial mind-map engine.
- TIDY_
TREE_ LAYOUT_ ENGINE_ ID - Stable engine id for the built-in tidy tree engine.
Traits§
- Layout
Engine - Headless layout engine contract.
Functions§
- apply_
dugong_ layout - Runs dugong layout and commits the resulting transaction through normal store dispatch.
- apply_
layout - Runs a selected layout engine and commits the resulting transaction through normal store dispatch.
- builtin_
layout_ engine_ registry - Returns a registry containing Jellyflow’s built-in layout engines.
- dugong_
layout_ transaction - Runs dugong layout and returns the transaction that would move changed nodes.
- layout_
context_ from_ store - Builds a layout context from non-persisted runtime facts already known by the store.
- layout_
graph_ to_ transaction_ with_ dugong - Runs
dugongand converts the node positions into a Jellyflow transaction. - layout_
graph_ to_ transaction_ with_ engine - Runs a layout engine and converts the node positions into a Jellyflow transaction.
- layout_
graph_ to_ transaction_ with_ mind_ map_ freeform - Runs the native freeform mind-map engine and converts the result into a transaction.
- layout_
graph_ to_ transaction_ with_ mind_ map_ radial - Runs the native radial mind-map engine and converts the result into a transaction.
- layout_
graph_ to_ transaction_ with_ tidy_ tree - Runs the native tidy tree engine and converts the result into a transaction.
- layout_
graph_ with_ dugong - Runs a Dagre-compatible layout using the
dugongbackend. - layout_
graph_ with_ engine - Runs a layout engine by id.
- layout_
graph_ with_ mind_ map_ freeform - Runs the native freeform mind-map engine.
- layout_
graph_ with_ mind_ map_ radial - Runs the native radial mind-map engine.
- layout_
graph_ with_ tidy_ tree - Runs the native tidy tree engine.
- layout_
transaction - Runs a selected layout engine and returns the transaction that would move changed nodes.
- plan_
dugong_ layout - Runs dugong layout for a graph without mutating runtime state.
- plan_
layout - Runs a selected layout engine for a graph without mutating runtime state.