layout

My Layout Plugin

Table of Contents

• Build
• Install
• Customise
• Plugin metadata
• License

A kUML layout plugin skeleton. Replace MyLayoutEngine.layout() with your layout algorithm.

Build

./gradlew build

JAR: build/libs/my-layout-plugin-1.0.0.jar

Install

kuml plugin install build/libs/my-layout-plugin-1.0.0.jar

Use your engine via frontmatter in a .kuml.kts file:

diagram(name = "Example", layout = "my-layout-plugin") { ... }

Customise

Edit src/main/kotlin/com/example/plugin/layout/MyLayoutPlugin.kt. Implement MyLayoutEngine.layout() — it receives a LayoutGraph and must return a LayoutResult with a NodeLayout (bounds + ports) for every node and an EdgeRoute for every edge.

Plugin metadata

Plugin id	com.example.my-layout-plugin
Category	layout
kUML range	>=0.16.0
Maintainer	Your Name <your@email.com>
License	Apache-2.0

License

Apache License 2.0.