Skip to main content

Module layout

Module layout 

Source
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§

DugongLayoutApplyOutcome
Result of applying a dugong layout through the store.
DugongLayoutEngine
Built-in Dagre-compatible layout engine powered by dugong.
LayoutApplyOutcome
Result of applying a layout engine through the store.
LayoutContext
Runtime or host-owned context available to layout engines.
LayoutEdgeRoute
A layout-produced edge route.
LayoutEngineId
Stable identifier for a layout engine.
LayoutEngineMetadata
Discovery metadata for one layout engine.
LayoutEngineRegistry
Caller-owned registry of layout engines.
LayoutEngineRequest
Request for one selected layout engine.
LayoutFamilyId
Stable identifier for a layout engine family.
LayoutFamilyMetadata
Metadata for a group of layout engines with related behavior.
LayoutNodePosition
A node position produced by a layout run.
LayoutOptions
Options shared by Jellyflow layout adapters.
LayoutPresetBuilder
Builder for common layout presets.
LayoutRequest
A headless layout request.
LayoutResult
Result of a headless layout run.
LayoutSpacing
Spacing knobs passed through to layout engines that support layered spacing.
MindMapFreeformLayoutEngine
Built-in freeform mind-map engine that only resolves overlaps.
MindMapRadialLayoutEngine
Built-in radial mind-map engine.
TidyTreeLayoutEngine
Built-in tidy tree layout engine.

Enums§

DugongLayoutApplyError
Errors from planning or dispatching a dugong layout.
LayoutApplyError
Errors from planning or dispatching a layout engine.
LayoutDirection
Direction for a layered graph layout.
LayoutEngineCapability
Public capabilities hosts can use when choosing a layout engine.
LayoutError
Errors reported by layout projection, registry lookup, or layout output conversion.
LayoutScope
Which nodes a layout request should include.

Constants§

DUGONG_LAYOUT_ENGINE_ID
Stable engine id for the built-in Dagre-compatible dugong engine.
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§

LayoutEngine
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 dugong and 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 dugong backend.
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.